@eveble/eveble

Hierarchy

↳ Serializable

• Serializable

  ↳ Message

  ↳ Command

  ↳ Event

Implemented by

• Command
• DomainException
• Event
• Message
• ScheduleCommand
• UnscheduleCommand

Index

Properties

• metadata
• timestamp

Methods

• assignMetadata
• equals
• getCorrelationId
• getLegacyTransformer
• getLegacyTransformers
• getMetadata
• getPropTypes
• getPropertyInitializers
• getSchemaVersion
• getTimestamp
• getTypeName
• hasCorrelationId
• hasLegacyTransformer
• hasMetadata
• overrideLegacyTransformer
• registerLegacyTransformer
• setCorrelationId
• toPlainObject
• toString
• transformLegacyProps
• validateProps

Properties

Optional metadata

• metadata? : Record‹string, any›

---

Optional timestamp

• timestamp? : Date

Methods

assignMetadata

▸ assignMetadata(props: Record‹string, any›): void

Parameters:

Name	Type
props	Record‹string, any›

Returns: void

▸ assignMetadata(props: Record‹string, any›): void

Parameters:

Name	Type
props	Record‹string, any›

Returns: void

---

equals

▸ equals(other: any): boolean

Inherited from Definable.equals

Overrides void

Parameters:

Name	Type
other	any

Returns: boolean

---

getCorrelationId

▸ getCorrelationId(key: string): string | undefined

Parameters:

Name	Type
key	string

Returns: string | undefined

▸ getCorrelationId(key: string): string | undefined

Parameters:

Name	Type
key	string

Returns: string | undefined

---

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

---

getMetadata

▸ getMetadata(): Record‹string, any›

Returns: Record‹string, any›

▸ getMetadata(): Record‹string, any›

Returns: Record‹string, any›

---

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

---

getTimestamp

▸ getTimestamp(): Date

Returns: Date

▸ getTimestamp(): Date

Returns: Date

---

getTypeName

▸ getTypeName(): TypeName

Inherited from Serializable.getTypeName

Overrides void

Returns: TypeName

---

hasCorrelationId

▸ hasCorrelationId(key: string): boolean

Parameters:

Name	Type
key	string

Returns: boolean

▸ hasCorrelationId(key: string): boolean

Parameters:

Name	Type
key	string

Returns: boolean

---

hasLegacyTransformer

▸ hasLegacyTransformer(schemaVersion: number): boolean

Inherited from Versionable.hasLegacyTransformer

Overrides void

Parameters:

Name	Type
schemaVersion	number

Returns: boolean

---

hasMetadata

▸ hasMetadata(): boolean

Returns: boolean

▸ hasMetadata(): boolean

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

---

setCorrelationId

▸ setCorrelationId(key: string, id: Stringifiable): void

Parameters:

Name	Type
key	string
id	Stringifiable

Returns: void

▸ setCorrelationId(key: string, id: Stringifiable): void

Parameters:

Name	Type
key	string
id	Stringifiable

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