Command

Type parameters

▪ T: object

▪ T: SuperConstructor

▪ T: object

▪ T: SuperConstructor

Hierarchy

↳ Message

Message
↳ Command
↳ ScheduleCommand
↳ UnscheduleCommand

Implements

Definable
Hookable
Ejsonable
Message
Command
Identifiable
Definable
Hookable
Ejsonable
Message
Command
Identifiable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

+ new Command(props: ConstructorType‹T› & object): Command

Overrides Message.constructor

Creates an instance of Message. Creates an instance of Message.

Parameters:

Name	Type	Description
`props`	ConstructorType‹T› & object	Properties matching generic `T` with `targetId` as `Guid

Returns: Command

Properties

`Optional` metadata

• metadata? : Record‹string, any›

Implementation of Command.metadata

Inherited from Message.metadata

Overrides CreateEmployee.metadata

`Optional` schemaVersion

• schemaVersion? : number

Inherited from Serializable.schemaVersion

Overrides VersionableMixin.schemaVersion

targetId

• targetId: Guid | string

Implementation of Command.targetId

`Optional` timestamp

• timestamp? : Date

Implementation of Command.timestamp

Inherited from Message.timestamp

Overrides CreateEmployee.timestamp

Methods

assignMetadata

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

Implementation of Command

Inherited from Message.assignMetadata

Overrides CreateEmployee.assignMetadata

Parameters:

Name	Type
`props`	Record‹string, any›

Returns: void

equals

▸ equals(other: any): boolean

Implementation of Identifiable

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

getAssignment

▸ getAssignment(): Assignment | undefined

Implementation of Command

Returns scheduling assignment if present.

Returns: Assignment | undefined

Instance of Assignment, else undefined.

getCorrelationId

▸ getCorrelationId(key: string): string | undefined

Implementation of Command

Inherited from Message.getCorrelationId

Overrides CreateEmployee.getCorrelationId

Parameters:

Name	Type
`key`	string

Returns: string | undefined

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

getId

▸ getId(): Guid | string

Implementation of Identifiable

Returns command's targeted element by id.

Returns: Guid | string

Command's target identifier as a instance of Guid or string.

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Implementation of Identifiable

Inherited from VersionableMixin.getLegacyTransformer

Overrides CreateEmployee.getLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number

Returns: Hook

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Implementation of Identifiable

Inherited from VersionableMixin.getLegacyTransformers

Overrides CreateEmployee.getLegacyTransformers

Returns: LegacyTransformers

getMetadata

▸ getMetadata(): Record‹string, any›

Implementation of Command

Inherited from Message.getMetadata

Overrides CreateEmployee.getMetadata

Returns: Record‹string, any›

getPropTypes

▸ getPropTypes(): Props

Implementation of Identifiable

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

getPropertyInitializers

▸ getPropertyInitializers(): Props

Implementation of Identifiable

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Implementation of Identifiable

Inherited from VersionableMixin.getSchemaVersion

Overrides CreateEmployee.getSchemaVersion

Returns: number | undefined

getTimestamp

▸ getTimestamp(): Date

Implementation of Command

Inherited from Message.getTimestamp

Overrides CreateEmployee.getTimestamp

Returns: Date

getTypeName

▸ getTypeName(): TypeName

Implementation of Identifiable

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

hasCorrelationId

▸ hasCorrelationId(key: string): boolean

Implementation of Command

Inherited from Message.hasCorrelationId

Overrides CreateEmployee.hasCorrelationId

Parameters:

Name	Type
`key`	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 Identifiable

Inherited from VersionableMixin.hasLegacyTransformer

Overrides CreateEmployee.hasLegacyTransformer

Parameters:

Name	Type
`schemaVersion`	number

Returns: boolean

hasMetadata

▸ hasMetadata(): boolean

Implementation of Command

Inherited from Message.hasMetadata

Overrides CreateEmployee.hasMetadata

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›

isDeliverable

▸ isDeliverable(): boolean

Implementation of Command

Evaluates if message is deliverable(i.e. is not scheduled or is past delivery time).

Returns: boolean

Returns true if command is deliverable, else false.

isScheduled

▸ isScheduled(): boolean

Implementation of Command

Evaluates if command is scheduled for delivery.

Returns: boolean

Returns true if command is scheduled, else false.

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 Identifiable

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 Identifiable

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

schedule

▸ schedule(assignment: Assignment): void

Implementation of Command

Schedules command for delivery at specific time.

Parameters:

Name	Type	Description
`assignment`	Assignment	Scheduling assignment information.

Returns: void

setCorrelationId

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

Implementation of Command

Inherited from Message.setCorrelationId

Overrides CreateEmployee.setCorrelationId

Parameters:

Name	Type
`key`	string
`id`	Stringifiable

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 Identifiable

Inherited from DefinableMixin.toPlainObject

Overrides CreateEmployee.toPlainObject

Returns: Props

toString

▸ toString(): TypeName

Implementation of Identifiable

Inherited from SerializableMixin.toString

Overrides CreateEmployee.toString

Returns: TypeName

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Implementation of Identifiable

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#

Optional metadata#

Optional schemaVersion#

targetId#

Optional timestamp#

Methods#

assignMetadata#

equals#

getActions#

getAssignment#

getCorrelationId#

getHook#

getHookOrThrow#

getHooks#

getId#

getLegacyTransformer#

getLegacyTransformers#

getMetadata#

getPropTypes#

getPropertyInitializers#

getSchemaVersion#

getTimestamp#

getTypeName#

hasAction#

hasCorrelationId#

hasHook#

hasLegacyTransformer#

hasMetadata#

in#

isDeliverable#

isScheduled#

overrideHook#

overrideLegacyTransformer#

processSerializableList#

registerHook#

registerLegacyTransformer#

removeHook#

schedule#

setCorrelationId#

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

`Optional` metadata

`Optional` schemaVersion

targetId

`Optional` timestamp

Methods

assignMetadata

equals

getActions

getAssignment

getCorrelationId

getHook

getHookOrThrow

getHooks

getId

getLegacyTransformer

getLegacyTransformers

getMetadata

getPropTypes

getPropertyInitializers

getSchemaVersion

getTimestamp

getTypeName

hasAction

hasCorrelationId

hasHook

hasLegacyTransformer

hasMetadata

in

isDeliverable

isScheduled

overrideHook

overrideLegacyTransformer

processSerializableList

registerHook

registerLegacyTransformer

removeHook

schedule

setCorrelationId

toJSONValue

toPlainObject

toString

transformLegacyProps

typeName

validateProps

`Static` disableSerializableLists

`Static` enableSerializableLists

`Static` from

`Static` getPropTypes

`Static` getPropertyInitializers

`Static` getTypeName

`Static` toString

`Static` typeName