@eveble/eveble

Hierarchy

↳ Serializable

• Serializable

  ↳ Commit

Implemented by

• Commit

Index

Properties

• commands
• eventSourceableType
• events
• id
• insertedAt
• receivers
• sentBy
• sourceId
• version

Methods

• addReceiver
• equals
• getCommandTypeNames
• getEventTypeNames
• getLegacyTransformer
• getLegacyTransformers
• getPropTypes
• getPropertyInitializers
• getReceiver
• getSchemaVersion
• getTypeName
• hasLegacyTransformer
• overrideLegacyTransformer
• registerLegacyTransformer
• toPlainObject
• toString
• transformLegacyProps
• validateProps

Properties

commands

• commands: Command[]

---

eventSourceableType

• eventSourceableType: string

---

events

• events: Event[]

---

id

• id: string

---

insertedAt

• insertedAt: Date

---

receivers

• receivers: CommitReceiver[]

---

sentBy

• sentBy: string

---

sourceId

• sourceId: string

---

version

• version: number

Methods

addReceiver

▸ addReceiver(receiver: CommitReceiver): void

Parameters:

Name	Type
receiver	CommitReceiver

Returns: void

▸ addReceiver(receiver: CommitReceiver): void

Parameters:

Name	Type
receiver	CommitReceiver

Returns: void

---

equals

▸ equals(other: any): boolean

Inherited from Definable.equals

Overrides void

Parameters:

Name	Type
other	any

Returns: boolean

---

getCommandTypeNames

▸ getCommandTypeNames(): TypeName[]

Returns: TypeName[]

▸ getCommandTypeNames(): TypeName[]

Returns: TypeName[]

---

getEventTypeNames

▸ getEventTypeNames(): TypeName[]

Returns: TypeName[]

▸ getEventTypeNames(): TypeName[]

Returns: TypeName[]

---

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

---

getReceiver

▸ getReceiver(appId: string): CommitReceiver | undefined

Parameters:

Name	Type
appId	string

Returns: CommitReceiver | undefined

▸ getReceiver(appId: string): CommitReceiver | undefined

Parameters:

Name	Type
appId	string

Returns: CommitReceiver | undefined

---

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