Process

Type parameters

▪ T: SuperConstructor

▪ T: SuperConstructor

Hierarchy

↳ EventSourceable

• EventSourceable

  ↳ Process

Implements

• Stateful
• Definable
• Hookable
• Ejsonable
• Statusful
• Entity
• Controller
• EventSourceable
• Controller
• Stateful
• Definable
• Hookable
• Ejsonable
• Statusful
• Entity
• EventSourceable

Index

Constructors

• constructor

Properties

• [COMMANDS_KEY]
• [EVENTS_KEY]
• id
• metadata
• schemaVersion
• state
• status
• version
• correlationKey

Accessors

• ableTo
• can
• ensure
• is

Methods

• [ROLLBACK_STATE_METHOD_KEY]
• [SAVE_STATE_METHOD_KEY]
• assignMetadata
• commandProps
• ensureHandleability
• equals
• eventProps
• getActions
• getCommands
• getCorrelationKey
• getEvents
• getHandleableTypes
• getHandled
• getHandledCommands
• getHandledEvents
• getHandledMessages
• getHandledTypes
• getHandledTypesNames
• getHandler
• getHandlerOrThrow
• getHandlers
• getHook
• getHookOrThrow
• getHooks
• getId
• getLegacyTransformer
• getLegacyTransformers
• getPropTypes
• getPropertyInitializers
• getSchemaVersion
• getSelectableStates
• getSelectableStatuses
• getState
• getStatus
• getTypeByHandler
• getTypeName
• getVersion
• handle
• handles
• hasAction
• hasHandler
• hasHook
• hasLegacyTransformer
• hasState
• hasStatus
• in
• incrementVersion
• initialize
• isHandleabe
• isInOneOfStates
• isInOneOfStatuses
• isInState
• isInStatus
• isStateSaved
• on
• overrideHandler
• overrideHook
• overrideLegacyTransformer
• processSerializableList
• record
• registerHandler
• registerHook
• registerLegacyTransformer
• removeHandler
• removeHook
• replay
• replayHistory
• schedule
• setHandleableTypes
• setState
• setStatus
• setVersion
• subscribes
• toJSONValue
• toPlainObject
• toString
• transformLegacyProps
• trigger
• typeName
• unschedule
• validateProps
• validateState
• validateStatus
• disableSerializableLists
• enableSerializableLists
• from
• getCorrelationKey
• getPropTypes
• getPropertyInitializers
• getTypeName
• resolveInitializingMessage
• resolveRoutedCommands
• resolveRoutedEvents
• resolveRoutedMessages
• setCorrelationKey
• toString
• typeName

Constructors

constructor

+ new Process(arg: History | Command‹object› | Event‹object› | Props): Process

Overrides EventSourceable.constructor

Creates an instance of Process. Flows:

1. Replay History - Process is recreated from History instance - list of Events(manual initialization and replay is required before running Aggregate.prototype.replayHistory!).
2. Command|Event - Command or Event instance is passed as initializing message and Process has assigned id from it.
3. Properties - Process is deserialized, so props as object are passed. Creates an instance of Process. Flows:
4. Replay History - Process is recreated from History instance - list of Events(manual initialization and replay is required before running Aggregate.prototype.replayHistory!).
5. Command|Event - Command or Event instance is passed as initializing message and Process has assigned id from it.
6. Properties - Process is deserialized, so props as object are passed.

example

new Process(

new History([

new Event({targetId: 'my-id', key: 'value'})

])

);

new Process(new Command({targetId: 'my-id', key: 'value'}));

new Process(new Event({targetId: 'my-id', key: 'value'}));

new Process({id: 'my-id'}); // 3

new Process({id: 'my-id', key: 'value'}); // 3

throws {InvalidInitializingMessageError} Thrown if provided initializing message is not instance of Command or Event.

example

new Process(

new History([

new Event({targetId: 'my-id', key: 'value'})

])

);

new Process(new Command({targetId: 'my-id', key: 'value'}));

new Process(new Event({targetId: 'my-id', key: 'value'}));

new Process({id: 'my-id'}); // 3

new Process({id: 'my-id', key: 'value'}); // 3

throws {InvalidInitializingMessageError} Thrown if provided initializing message is not instance of Command or Event.

Parameters:

Name	Type	Description
arg	History | Command‹object› | Event‹object› | Props	Instance of: History, Command, Event or properties.

Returns: Process

Properties

[COMMANDS_KEY]

• [COMMANDS_KEY]: Command[]

Overrides EventSourceable.[COMMANDS_KEY]

---

[EVENTS_KEY]

• [EVENTS_KEY]: Event[]

Overrides EventSourceable.[EVENTS_KEY]

---

id

• id: string | Guid

Overrides EventSourceable.id

---

Optional metadata

• metadata? : Record‹string, any›

Overrides EventSourceable.metadata

---

Optional schemaVersion

• schemaVersion? : number

Overrides EventSourceable.schemaVersion

---

state

• state: State

Implementation of EventSourceable.state

Overrides EventSourceable.state

---

status

• status: Status

Implementation of EventSourceable.status

Overrides EventSourceable.status

---

version

• version: number

Overrides EventSourceable.version

---

Static Optional correlationKey

▪ correlationKey? : string

Accessors

ableTo

• get ableTo(): this

Inherited from Entity.ableTo

Overrides Task.ableTo

Returns: this

---

can

• get can(): any

Inherited from Entity.can

Overrides Task.can

Returns: any

---

ensure

• get ensure(): this & object

Inherited from Entity.ensure

Overrides Task.ensure

Returns: this & object

---

is

• get is(): this & object

Inherited from Entity.is

Overrides Task.is

Returns: this & object

Methods

[ROLLBACK_STATE_METHOD_KEY]

▸ [ROLLBACK_STATE_METHOD_KEY](): void

Implementation of EventSourceable

Inherited from Entity.[ROLLBACK_STATE_METHOD_KEY]

Overrides Task.[ROLLBACK_STATE_METHOD_KEY]

Returns: void

---

[SAVE_STATE_METHOD_KEY]

▸ [SAVE_STATE_METHOD_KEY](): void

Implementation of EventSourceable

Inherited from Entity.[SAVE_STATE_METHOD_KEY]

Overrides Task.[SAVE_STATE_METHOD_KEY]

Returns: void

---

assignMetadata

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

Implementation of EventSourceable

Inherited from EventSourceable.assignMetadata

Overrides CancelingEmployment.assignMetadata

Parameters:

Name	Type
metadata	Record‹string, any›

Returns: void

---

commandProps

▸ commandProps(): object

Inherited from EventSourceable.commandProps

Overrides CancelingEmployment.commandProps

Returns: object

• metadata: Record‹string, any›

• timestamp: Date

---

ensureHandleability

▸ ensureHandleability(messageType: MessageType‹Message›, handleableTypes?: MessageType‹Message› | MessageType‹Message›[]): boolean

Implementation of EventSourceable

Inherited from HandlingMixin.ensureHandleability

Overrides CancelingEmployment.ensureHandleability

Parameters:

Name	Type
messageType	MessageType‹Message›
handleableTypes?	MessageType‹Message› | MessageType‹Message›[]

Returns: boolean

---

equals

▸ equals(otherEntity: Entity): boolean

Inherited from Entity.equals

Overrides DefinableMixin.equals

Parameters:

Name	Type
otherEntity	Entity

Returns: boolean

---

eventProps

▸ eventProps(): object

Implementation of EventSourceable

Inherited from EventSourceable.eventProps

Overrides CancelingEmployment.eventProps

Returns: object

• metadata: Record‹string, any›

• sourceId: Guid | string

• timestamp: Date

• version: number

---

getActions

▸ getActions(): Actions

Implementation of Hookable

Inherited from HookableMixin.getActions

Overrides CreateEmployee.getActions

Returns: Actions

---

getCommands

▸ getCommands(): Command[]

Implementation of EventSourceable

Inherited from EventSourceable.getCommands

Overrides CancelingEmployment.getCommands

Returns: Command[]

---

getCorrelationKey

▸ getCorrelationKey(): string

Returns correlation key for Process.

Returns: string

Custom predefined correlation key or Process type name.

---

getEvents

▸ getEvents(): Event[]

Implementation of EventSourceable

Inherited from EventSourceable.getEvents

Overrides CancelingEmployment.getEvents

Returns: Event[]

---

getHandleableTypes

▸ getHandleableTypes(): MessageType‹Message›[]

Implementation of EventSourceable

Inherited from HandlingMixin.getHandleableTypes

Overrides CancelingEmployment.getHandleableTypes

Returns: MessageType‹Message›[]

---

getHandled

▸ getHandled(messageType: MessageType‹Message›): MessageType‹Message›[]

Implementation of EventSourceable

Inherited from HandlingMixin.getHandled

Overrides CancelingEmployment.getHandled

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: MessageType‹Message›[]

---

getHandledCommands

▸ getHandledCommands(): MessageType‹Command›[]

Inherited from HandlingMixin.getHandledCommands

Overrides CancelingEmployment.getHandledCommands

Returns: MessageType‹Command›[]

---

getHandledEvents

▸ getHandledEvents(): MessageType‹Event›[]

Inherited from HandlingMixin.getHandledEvents

Overrides CancelingEmployment.getHandledEvents

Returns: MessageType‹Event›[]

---

getHandledMessages

▸ getHandledMessages(): MessageType‹Message›[]

Inherited from HandlingMixin.getHandledMessages

Overrides CancelingEmployment.getHandledMessages

Returns: MessageType‹Message›[]

---

getHandledTypes

▸ getHandledTypes(): MessageType‹Message›[]

Implementation of EventSourceable

Inherited from HandlingMixin.getHandledTypes

Overrides CancelingEmployment.getHandledTypes

Returns: MessageType‹Message›[]

---

getHandledTypesNames

▸ getHandledTypesNames(): TypeName[]

Inherited from HandlingMixin.getHandledTypesNames

Overrides CancelingEmployment.getHandledTypesNames

Returns: TypeName[]

---

getHandler

▸ getHandler(messageType: MessageType‹Message›): Handler | undefined

Implementation of EventSourceable

Inherited from OneToOneHandlingMixin.getHandler

Overrides CancelingEmployment.getHandler

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: Handler | undefined

---

getHandlerOrThrow

▸ getHandlerOrThrow(messageType: MessageType‹Message›): Handler

Implementation of EventSourceable

Inherited from OneToOneHandlingMixin.getHandlerOrThrow

Overrides CancelingEmployment.getHandlerOrThrow

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: Handler

---

getHandlers

▸ getHandlers(): Map‹MessageType‹Message›, Handler | Handler[]›

Implementation of EventSourceable

Inherited from HandlingMixin.getHandlers

Overrides CancelingEmployment.getHandlers

Returns: Map‹MessageType‹Message›, Handler | Handler[]›

---

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(): string | Guid

Implementation of EventSourceable

Inherited from Entity.getId

Overrides Task.getId

Returns: string | Guid

---

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Implementation of EventSourceable

Inherited from VersionableMixin.getLegacyTransformer

Overrides CreateEmployee.getLegacyTransformer

Parameters:

Name	Type
schemaVersion	number

Returns: Hook

---

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Implementation of EventSourceable

Inherited from VersionableMixin.getLegacyTransformers

Overrides CreateEmployee.getLegacyTransformers

Returns: LegacyTransformers

---

getPropTypes

▸ getPropTypes(): Props

Implementation of EventSourceable

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

---

getPropertyInitializers

▸ getPropertyInitializers(): Props

Implementation of EventSourceable

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

---

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Implementation of EventSourceable

Inherited from VersionableMixin.getSchemaVersion

Overrides CreateEmployee.getSchemaVersion

Returns: number | undefined

---

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Implementation of EventSourceable

Inherited from StatefulMixin.getSelectableStates

Overrides Task.getSelectableStates

Returns: Record‹string, State›

---

getSelectableStatuses

▸ getSelectableStatuses(): Record‹string, Status›

Implementation of EventSourceable

Inherited from StatusfulMixin.getSelectableStatuses

Overrides Task.getSelectableStatuses

Returns: Record‹string, Status›

---

getState

▸ getState(): State

Implementation of EventSourceable

Inherited from StatefulMixin.getState

Overrides Task.getState

Returns: State

---

getStatus

▸ getStatus(): Status

Implementation of EventSourceable

Inherited from StatusfulMixin.getStatus

Overrides Task.getStatus

Returns: Status

---

getTypeByHandler

▸ getTypeByHandler(handlerReference: Handler): any | undefined

Inherited from OneToOneHandlingMixin.getTypeByHandler

Overrides CancelingEmployment.getTypeByHandler

Parameters:

Name	Type
handlerReference	Handler

Returns: any | undefined

---

getTypeName

▸ getTypeName(): TypeName

Implementation of EventSourceable

Inherited from SerializableMixin.getTypeName

Overrides CreateEmployee.getTypeName

Returns: TypeName

---

getVersion

▸ getVersion(): number

Implementation of EventSourceable

Inherited from EventSourceable.getVersion

Overrides CancelingEmployment.getVersion

Returns: number

---

handle

▸ handle(message: Command | Event): Promise‹any›

Inherited from EventSourceable.handle

Overrides OneToOneHandlingMixin.handle

Parameters:

Name	Type
message	Command | Event

Returns: Promise‹any›

---

handles

▸ handles(): Map‹MessageType‹Command›, Handler›

Implementation of EventSourceable

Inherited from HandlingMixin.handles

Overrides CancelingEmployment.handles

Returns: Map‹MessageType‹Command›, Handler›

---

hasAction

▸ hasAction(action: string): boolean

Implementation of Hookable

Inherited from HookableMixin.hasAction

Overrides CreateEmployee.hasAction

Parameters:

Name	Type
action	string

Returns: boolean

---

hasHandler

▸ hasHandler(messageType: MessageType‹Message›): boolean

Implementation of EventSourceable

Inherited from HandlingMixin.hasHandler

Overrides CancelingEmployment.hasHandler

Parameters:

Name	Type
messageType	MessageType‹Message›

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 EventSourceable

Inherited from VersionableMixin.hasLegacyTransformer

Overrides CreateEmployee.hasLegacyTransformer

Parameters:

Name	Type
schemaVersion	number

Returns: boolean

---

hasState

▸ hasState(): boolean

Implementation of EventSourceable

Inherited from StatefulMixin.hasState

Overrides Task.hasState

Returns: boolean

---

hasStatus

▸ hasStatus(): boolean

Implementation of EventSourceable

Inherited from StatusfulMixin.hasStatus

Overrides Task.hasStatus

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›

---

incrementVersion

▸ incrementVersion(): void

Implementation of EventSourceable

Inherited from EventSourceable.incrementVersion

Overrides CancelingEmployment.incrementVersion

Returns: void

---

initialize

▸ initialize(): Promise‹void›

Implementation of EventSourceable

Inherited from EventSourceable.initialize

Overrides OneToOneHandlingMixin.initialize

Returns: Promise‹void›

---

isHandleabe

▸ isHandleabe(messageType: MessageType‹Message›, handleableTypes?: MessageType‹Message› | MessageType‹Message›[]): boolean

Inherited from HandlingMixin.isHandleabe

Overrides CancelingEmployment.isHandleabe

Parameters:

Name	Type
messageType	MessageType‹Message›
handleableTypes?	MessageType‹Message› | MessageType‹Message›[]

Returns: boolean

---

isInOneOfStates

▸ isInOneOfStates(states: State | State[]): boolean

Implementation of EventSourceable

Inherited from StatefulMixin.isInOneOfStates

Overrides Task.isInOneOfStates

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInOneOfStatuses

▸ isInOneOfStatuses(status: Status | Status[]): boolean

Implementation of EventSourceable

Inherited from StatusfulMixin.isInOneOfStatuses

Overrides Task.isInOneOfStatuses

Parameters:

Name	Type
status	Status | Status[]

Returns: boolean

---

isInState

▸ isInState(state: State | State[]): boolean

Implementation of EventSourceable

Inherited from StatefulMixin.isInState

Overrides Task.isInState

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

isInStatus

▸ isInStatus(status: Status | Status[]): boolean

Implementation of EventSourceable

Inherited from StatusfulMixin.isInStatus

Overrides Task.isInStatus

Parameters:

Name	Type
status	Status | Status[]

Returns: boolean

---

isStateSaved

▸ isStateSaved(): boolean

Implementation of EventSourceable

Inherited from Entity.isStateSaved

Overrides Task.isStateSaved

Returns: boolean

---

on

▸ on(action: string | Stringifiable): this

Implementation of EventSourceable

Inherited from Entity.on

Overrides Task.on

Parameters:

Name	Type
action	string | Stringifiable

Returns: this

---

overrideHandler

▸ overrideHandler(messageType: MessageType‹Message›, handler: Handler): void

Implementation of EventSourceable

Inherited from HandlingMixin.overrideHandler

Overrides CancelingEmployment.overrideHandler

Parameters:

Name	Type
messageType	MessageType‹Message›
handler	Handler

Returns: void

---

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 EventSourceable

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

---

record

▸ record(event: Event): void

Implementation of EventSourceable

Inherited from EventSourceable.record

Overrides CancelingEmployment.record

Parameters:

Name	Type
event	Event

Returns: void

---

registerHandler

▸ registerHandler(messageType: MessageType‹Message›, handler: Handler, shouldOverride?: boolean): void

Implementation of EventSourceable

Inherited from OneToOneHandlingMixin.registerHandler

Overrides HandlingMixin.registerHandler

Parameters:

Name	Type
messageType	MessageType‹Message›
handler	Handler
shouldOverride?	boolean

Returns: void

---

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 EventSourceable

Inherited from VersionableMixin.registerLegacyTransformer

Overrides CreateEmployee.registerLegacyTransformer

Parameters:

Name	Type
schemaVersion	number
transformer	Hook
shouldOverride?	boolean

Returns: void

---

removeHandler

▸ removeHandler(messageType: MessageType‹Message›): void

Implementation of EventSourceable

Inherited from HandlingMixin.removeHandler

Overrides CancelingEmployment.removeHandler

Parameters:

Name	Type
messageType	MessageType‹Message›

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

---

replay

▸ replay(event: Event): void

Implementation of EventSourceable

Inherited from EventSourceable.replay

Overrides CancelingEmployment.replay

Parameters:

Name	Type
event	Event

Returns: void

---

replayHistory

▸ replayHistory(history: History): void

Inherited from EventSourceable.replayHistory

Overrides CancelingEmployment.replayHistory

Parameters:

Name	Type
history	History

Returns: void

---

schedule

▸ schedule(command: Command, deliverAt: Date, assignmentId?: string | Guid): void

Implementation of EventSourceable

Inherited from EventSourceable.schedule

Overrides CancelingEmployment.schedule

Parameters:

Name	Type
command	Command
deliverAt	Date
assignmentId?	string | Guid

Returns: void

---

setHandleableTypes

▸ setHandleableTypes(handleableTypes: MessageType‹Message› | MessageType‹Message›[]): void

Implementation of EventSourceable

Inherited from HandlingMixin.setHandleableTypes

Overrides CancelingEmployment.setHandleableTypes

Parameters:

Name	Type
handleableTypes	MessageType‹Message› | MessageType‹Message›[]

Returns: void

---

setState

▸ setState(state: State): void

Implementation of EventSourceable

Inherited from StatefulMixin.setState

Overrides Task.setState

Parameters:

Name	Type
state	State

Returns: void

---

setStatus

▸ setStatus(status: Status): void

Implementation of EventSourceable

Inherited from StatusfulMixin.setStatus

Overrides Task.setStatus

Parameters:

Name	Type
status	Status

Returns: void

---

setVersion

▸ setVersion(version: number): void

Inherited from EventSourceable.setVersion

Overrides CancelingEmployment.setVersion

Parameters:

Name	Type
version	number

Returns: void

---

subscribes

▸ subscribes(): Map‹MessageType‹Event›, Handler›

Implementation of EventSourceable

Inherited from HandlingMixin.subscribes

Overrides CancelingEmployment.subscribes

Returns: Map‹MessageType‹Event›, Handler›

---

toJSONValue

▸ toJSONValue(): Record‹string, any›

Implementation of Ejsonable

Inherited from SerializableMixin.toJSONValue

Overrides CreateEmployee.toJSONValue

Returns: Record‹string, any›

---

toPlainObject

▸ toPlainObject(): Props

Implementation of EventSourceable

Inherited from DefinableMixin.toPlainObject

Overrides CreateEmployee.toPlainObject

Returns: Props

---

toString

▸ toString(): TypeName

Implementation of EventSourceable

Inherited from SerializableMixin.toString

Overrides CreateEmployee.toString

Returns: TypeName

---

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Implementation of EventSourceable

Inherited from VersionableMixin.transformLegacyProps

Overrides CreateEmployee.transformLegacyProps

Parameters:

Name	Type
props	Props

Returns: Props

---

trigger

▸ trigger(command: Command): void

Adds Command instance to command that should be triggered.

Parameters:

Name	Type	Description
command	Command	Instance of Command.

Returns: void

---

typeName

▸ typeName(): TypeName

Implementation of Ejsonable

Inherited from EjsonableMixin.typeName

Overrides CreateEmployee.typeName

Returns: TypeName

---

unschedule

▸ unschedule(assignmentId: string | Guid, commandType: MessageType‹Command›): void

Implementation of EventSourceable

Inherited from EventSourceable.unschedule

Overrides CancelingEmployment.unschedule

Parameters:

Name	Type
assignmentId	string | Guid
commandType	MessageType‹Command›

Returns: void

---

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

---

validateState

▸ validateState(stateOrStates: State | State[], error?: Error): boolean

Implementation of EventSourceable

Inherited from StatefulMixin.validateState

Overrides Task.validateState

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean

---

validateStatus

▸ validateStatus(statusOrStatuses: Status | Status[], error?: Error): boolean

Implementation of EventSourceable

Inherited from StatusfulMixin.validateStatus

Overrides Task.validateStatus

Parameters:

Name	Type
statusOrStatuses	Status | Status[]
error?	Error

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 getCorrelationKey

▸ getCorrelationKey(): string

Returns correlation key.

Returns: string

Custom predefined correlation key or Process type name.

---

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 resolveInitializingMessage

▸ resolveInitializingMessage(): MessageType‹Command | Event› | undefined

Inherited from EventSourceable.resolveInitializingMessage

Overrides CancelingEmployment.resolveInitializingMessage

Returns: MessageType‹Command | Event› | undefined

---

Static resolveRoutedCommands

▸ resolveRoutedCommands(): MessageType‹Command›[]

Inherited from EventSourceable.resolveRoutedCommands

Overrides CancelingEmployment.resolveRoutedCommands

Returns: MessageType‹Command›[]

---

Static resolveRoutedEvents

▸ resolveRoutedEvents(): MessageType‹Event›[]

Inherited from EventSourceable.resolveRoutedEvents

Overrides CancelingEmployment.resolveRoutedEvents

Returns: MessageType‹Event›[]

---

Static resolveRoutedMessages

▸ resolveRoutedMessages(): MessageType‹Command | Event›[]

Inherited from EventSourceable.resolveRoutedMessages

Overrides CancelingEmployment.resolveRoutedMessages

Returns: MessageType‹Command | Event›[]

---

Static setCorrelationKey

▸ setCorrelationKey(key: string): void

Sets correlation key.

Parameters:

Name	Type	Description
key	string	Key under which correlation will be set for Process.

Returns: void

---

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