@eveble/eveble

Hierarchy

↳ Serializable

• Serializable

  ↳ Identifiable

  ↳ Entity

Implemented by

• Command
• DomainException
• Event
• ScheduleCommand
• UnscheduleCommand

Index

Methods

• equals
• getId
• getLegacyTransformer
• getLegacyTransformers
• getPropTypes
• getPropertyInitializers
• getSchemaVersion
• getTypeName
• hasLegacyTransformer
• overrideLegacyTransformer
• registerLegacyTransformer
• toPlainObject
• toString
• transformLegacyProps
• validateProps

Methods

equals

▸ equals(other: any): boolean

Inherited from Definable.equals

Overrides void

Parameters:

Name	Type
other	any

Returns: boolean

---

getId

▸ getId(): string | Stringifiable

Returns: string | Stringifiable

▸ getId(): string | Stringifiable

Returns: string | Stringifiable

---

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Inherited from Versionable.getLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number

Returns: Hook

---

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Inherited from Versionable.getLegacyTransformers

Overrides void

Returns: LegacyTransformers

---

getPropTypes

▸ getPropTypes(): Record‹keyof any, any›

Inherited from Definable.getPropTypes

Overrides void

Returns: Record‹keyof any, any›

---

getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from Definable.getPropertyInitializers

Overrides void

Returns: Props

---

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Inherited from Versionable.getSchemaVersion

Overrides void

Returns: number | undefined

---

getTypeName

▸ getTypeName(): TypeName

Inherited from Serializable.getTypeName

Overrides void

Returns: TypeName

---

hasLegacyTransformer

▸ hasLegacyTransformer(schemaVersion: number): boolean

Inherited from Versionable.hasLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number

Returns: boolean

---

overrideLegacyTransformer

▸ overrideLegacyTransformer(schemaVersion: number, transformer: Hook): void

Inherited from Versionable.overrideLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number
transformer	Hook

Returns: void

---

registerLegacyTransformer

▸ registerLegacyTransformer(schemaVersion: number, transformer: Hook, shouldOverride: boolean): void

Inherited from Versionable.registerLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number
transformer	Hook
shouldOverride	boolean

Returns: void

---

toPlainObject

▸ toPlainObject(): Props

Inherited from Definable.toPlainObject

Overrides void

Returns: Props

---

toString

▸ toString(): TypeName | string

Inherited from Serializable.toString

Overrides void

Returns: TypeName | string

---

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Inherited from Versionable.transformLegacyProps

Overrides void

Parameters:

Name	Type
props	Props

Returns: Props

---

validateProps

▸ validateProps(props: Props, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from Definable.validateProps

Overrides void

Parameters:

Name	Type
props	Props
propTypes	PropTypes
isStrict?	boolean

Returns: boolean