Class Workflow<T>

Type Parameters

T extends WorkflowPlaces

Hierarchy

Workflow

Index

Constructors

Properties

definition events state

Methods

apply can isDone

Constructors

constructor

new Workflow<T>(definition: WorkflowDefinition<T>, state: WorkflowState<T>, eventDispatcher: EventDispatcher, injector: InjectorContext, stopwatch?: Stopwatch): Workflow<T>
Type Parameters
- T extends WorkflowPlaces
Parameters
- definition: WorkflowDefinition<T>
- state: WorkflowState<T>
- eventDispatcher: EventDispatcher
- injector: InjectorContext
- Optional stopwatch: Stopwatch
Returns Workflow<T>
- Defined in packages/workflow/src/workflow.ts:243

Properties

definition

definition: WorkflowDefinition<T>

`Protected` events

events: { [ name in string | number | symbol]?: Function } = {}

state

state: WorkflowState<T>

Methods

apply

apply<K>(nextState: K, event?: ExtractClassType<T[K]>): Promise<void>
Throws
WorkflowError when next state is not possible to apply.
Type Parameters
- K extends string | number | symbol
Parameters
- nextState: K
- Optional event: ExtractClassType<T[K]>
Returns Promise<void>
- Defined in packages/workflow/src/workflow.ts:259

can

can(nextState: keyof T & string): boolean
Parameters
- nextState: keyof T & string
Returns boolean
- Defined in packages/workflow/src/workflow.ts:252

isDone

isDone(): boolean
Returns boolean
- Defined in packages/workflow/src/workflow.ts:271

Generated using TypeDoc