Commit

Type parameters

▪ T: SuperConstructor

Hierarchy

↳ Serializable

Serializable
↳ Commit

Implements

Definable
Hookable
Ejsonable
Commit
Definable
Hookable
Ejsonable
Commit

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

+ new Commit(props?: Props): Commit

Inherited from Serializable.constructor

Overrides Struct.constructor

Parameters:

Name	Type
`props?`	Props

Returns: Commit

Properties

commands

• commands: Command[]

Implementation of Commit.commands

eventSourceableType

• eventSourceableType: string

Implementation of Commit.eventSourceableType

events

• events: Event[]

Implementation of Commit.events

id

• id: string

Implementation of Commit.id

insertedAt

• insertedAt: Date

Implementation of Commit.insertedAt

receivers

• receivers: CommitReceiver[]

Implementation of Commit.receivers

`Optional` schemaVersion

• schemaVersion? : number

Inherited from Serializable.schemaVersion

Overrides VersionableMixin.schemaVersion

sentBy

• sentBy: string

Implementation of Commit.sentBy

sourceId

• sourceId: string

Implementation of Commit.sourceId

version

• version: number

Implementation of Commit.version

Methods

addReceiver

▸ addReceiver(receiver: CommitReceiver): void

Implementation of Commit

Adds receiver to commit receivers list.

Parameters:

Name	Type	Description
`receiver`	CommitReceiver	Instance of `CommitReceiver`.

Returns: void

equals

▸ equals(other: any): boolean

Implementation of Commit

Inherited from DefinableMixin.equals

Overrides CreateEmployee.equals

Parameters:

Name	Type
`other`	any

Returns: boolean

getActions

▸ getActions(): Actions

Implementation of Hookable

Inherited from HookableMixin.getActions

Overrides CreateEmployee.getActions

Returns: Actions

getCommandTypeNames

▸ getCommandTypeNames(): TypeName[]

Implementation of Commit

Gets list of command type names.

Returns: TypeName[]

List with command type names.

getEventTypeNames

▸ getEventTypeNames(): TypeName[]

Implementation of Commit

Gets list of event type names.

Returns: TypeName[]

List with event type names.

getHook

▸ getHook(action: string, id: string): Hook | undefined

Implementation of Hookable

Inherited from HookableMixin.getHook

Overrides CreateEmployee.getHook

Parameters:

Name	Type
`action`	string
`id`	string

Returns: Hook | undefined

getHookOrThrow

▸ getHookOrThrow(action: string, id: string): Hook

Implementation of Hookable

Inherited from HookableMixin.getHookOrThrow

Overrides CreateEmployee.getHookOrThrow

Parameters:

Name	Type
`action`	string
`id`	string

Returns: Hook

getHooks

▸ getHooks(action: string): Mappings

Implementation of Hookable

Inherited from HookableMixin.getHooks

Overrides CreateEmployee.getHooks

Parameters:

Name	Type
`action`	string

Returns: Mappings

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Implementation of Commit

Inherited from VersionableMixin.getLegacyTransformer

Overrides CreateEmployee.getLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number

Returns: Hook

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Implementation of Commit

Inherited from VersionableMixin.getLegacyTransformers

Overrides CreateEmployee.getLegacyTransformers

Returns: LegacyTransformers

getPropTypes

▸ getPropTypes(): Props

Implementation of Commit

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

getPropertyInitializers

▸ getPropertyInitializers(): Props

Implementation of Commit

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

getReceiver

▸ getReceiver(appId: string): CommitReceiver | undefined

Implementation of Commit

Gets receiver for application by its id.

Parameters:

Name	Type	Description
`appId`	string	Application identifier.

Returns: CommitReceiver | undefined

Instance of CommitReceiver, else undefined.

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Implementation of Commit

Inherited from VersionableMixin.getSchemaVersion

Overrides CreateEmployee.getSchemaVersion

Returns: number | undefined

getTypeName

▸ getTypeName(): TypeName

Implementation of Commit

Inherited from SerializableMixin.getTypeName

Overrides CreateEmployee.getTypeName

Returns: TypeName

hasAction

▸ hasAction(action: string): boolean

Implementation of Hookable

Inherited from HookableMixin.hasAction

Overrides CreateEmployee.hasAction

Parameters:

Name	Type
`action`	string

Returns: boolean

hasHook

▸ hasHook(action: string, id: string): boolean

Implementation of Hookable

Inherited from HookableMixin.hasHook

Overrides CreateEmployee.hasHook

Parameters:

Name	Type
`action`	string
`id`	string

Returns: boolean

hasLegacyTransformer

▸ hasLegacyTransformer(schemaVersion: number): boolean

Implementation of Commit

Inherited from VersionableMixin.hasLegacyTransformer

Overrides CreateEmployee.hasLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number

Returns: boolean

in

▸ in‹T›(listName: string): List‹T›

Inherited from Serializable.in

Overrides CreateEmployee.in

Type parameters:

▪ T

Parameters:

Name	Type
`listName`	string

Returns: List‹T›

overrideHook

▸ overrideHook(action: string, id: string, hook: Hook): void

Implementation of Hookable

Inherited from HookableMixin.overrideHook

Overrides CreateEmployee.overrideHook

Parameters:

Name	Type
`action`	string
`id`	string
`hook`	Hook

Returns: void

overrideLegacyTransformer

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

Implementation of Commit

Inherited from VersionableMixin.overrideLegacyTransformer

Overrides CreateEmployee.overrideLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number
`transformer`	Hook

Returns: void

processSerializableList

▸ processSerializableList(props?: Props): Props

Inherited from Serializable.processSerializableList

Overrides CreateEmployee.processSerializableList

Parameters:

Name	Type
`props?`	Props

Returns: Props

registerHook

▸ registerHook(action: string, id: string, hook: Hook, shouldOverride?: boolean): void

Implementation of Hookable

Inherited from HookableMixin.registerHook

Overrides CreateEmployee.registerHook

Parameters:

Name	Type
`action`	string
`id`	string
`hook`	Hook
`shouldOverride?`	boolean

Returns: void

registerLegacyTransformer

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

Implementation of Commit

Inherited from VersionableMixin.registerLegacyTransformer

Overrides CreateEmployee.registerLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number
`transformer`	Hook
`shouldOverride?`	boolean

Returns: void

removeHook

▸ removeHook(action: string, id: string): void

Implementation of Hookable

Inherited from HookableMixin.removeHook

Overrides CreateEmployee.removeHook

Parameters:

Name	Type
`action`	string
`id`	string

Returns: void

toJSONValue

▸ toJSONValue(): Record‹string, any›

Implementation of Ejsonable

Inherited from SerializableMixin.toJSONValue

Overrides CreateEmployee.toJSONValue

Returns: Record‹string, any›

toPlainObject

▸ toPlainObject(): Props

Implementation of Commit

Inherited from DefinableMixin.toPlainObject

Overrides CreateEmployee.toPlainObject

Returns: Props

toString

▸ toString(): TypeName

Implementation of Commit

Inherited from SerializableMixin.toString

Overrides CreateEmployee.toString

Returns: TypeName

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Implementation of Commit

Inherited from VersionableMixin.transformLegacyProps

Overrides CreateEmployee.transformLegacyProps

Parameters:

Name	Type
`props`	Props

Returns: Props

typeName

▸ typeName(): TypeName

Implementation of Ejsonable

Inherited from EjsonableMixin.typeName

Overrides CreateEmployee.typeName

Returns: TypeName

validateProps

▸ validateProps(props: Record‹string | number | symbol, any› | undefined, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from DefinableMixin.validateProps

Overrides CreateEmployee.validateProps

Parameters:

Name	Type
`props`	Record‹string \| number \| symbol, any› \| undefined
`propTypes`	PropTypes
`isStrict?`	boolean

Returns: boolean

`Static` disableSerializableLists

▸ disableSerializableLists(): void

Inherited from Serializable.disableSerializableLists

Overrides CreateEmployee.disableSerializableLists

Returns: void

`Static` enableSerializableLists

▸ enableSerializableLists(): void

Inherited from Serializable.enableSerializableLists

Overrides CreateEmployee.enableSerializableLists

Returns: void

`Static` from

▸ from(...sources: Record‹string, any›[]): any

Inherited from Serializable.from

Overrides CreateEmployee.from

Parameters:

Name	Type
`...sources`	Record‹string, any›[]

Returns: any

`Static` getPropTypes

▸ getPropTypes(): Props

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

`Static` getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

`Static` getTypeName

▸ getTypeName(): TypeName

Inherited from SerializableMixin.getTypeName

Overrides CreateEmployee.getTypeName

Returns: TypeName

`Static` toString

▸ toString(): TypeName

Inherited from SerializableMixin.toString

Overrides CreateEmployee.toString

Returns: TypeName

`Static` typeName

▸ typeName(): TypeName

Inherited from EjsonableMixin.typeName

Overrides CreateEmployee.typeName

Returns: TypeName

Type parameters#

Hierarchy#

Implements#

Index#

Constructors#

Properties#

Methods#

Constructors#

constructor#

Properties#

commands#

eventSourceableType#

events#

id#

insertedAt#

receivers#

Optional schemaVersion#

sentBy#

sourceId#

version#

Methods#

addReceiver#

equals#

getActions#

getCommandTypeNames#

getEventTypeNames#

getHook#

getHookOrThrow#

getHooks#

getLegacyTransformer#

getLegacyTransformers#

getPropTypes#

getPropertyInitializers#

getReceiver#

getSchemaVersion#

getTypeName#

hasAction#

hasHook#

hasLegacyTransformer#

in#

overrideHook#

overrideLegacyTransformer#

processSerializableList#

registerHook#

registerLegacyTransformer#

removeHook#

toJSONValue#

toPlainObject#

toString#

transformLegacyProps#

typeName#

validateProps#

Static disableSerializableLists#

Static enableSerializableLists#

Static from#

Static getPropTypes#

Static getPropertyInitializers#

Static getTypeName#

Static toString#

Static typeName#

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

commands

eventSourceableType

events

id

insertedAt

receivers

`Optional` schemaVersion

sentBy

sourceId

version

Methods

addReceiver

equals

getActions

getCommandTypeNames

getEventTypeNames

getHook

getHookOrThrow

getHooks

getLegacyTransformer

getLegacyTransformers

getPropTypes

getPropertyInitializers

getReceiver

getSchemaVersion

getTypeName

hasAction

hasHook

hasLegacyTransformer

in

overrideHook

overrideLegacyTransformer

processSerializableList

registerHook

registerLegacyTransformer

removeHook

toJSONValue

toPlainObject

toString

transformLegacyProps

typeName

validateProps

`Static` disableSerializableLists

`Static` enableSerializableLists

`Static` from

`Static` getPropTypes

`Static` getPropertyInitializers

`Static` getTypeName

`Static` toString

`Static` typeName