Class WorkflowDefinition<T>

Type Parameters

T extends WorkflowPlaces

Hierarchy

WorkflowDefinition

Index

Constructors

Properties

name next places symbol tokens transitions

Methods

addTransition buildApplier create getEventToken getTransitionsFrom

Constructors

constructor

new WorkflowDefinition<T>(name: string, places: T, transitions?: WorkflowTransitions<T>): WorkflowDefinition<T>
Type Parameters
- T extends WorkflowPlaces
Parameters
- name: string
- places: T
- transitions: WorkflowTransitions<T> = {}
Returns WorkflowDefinition<T>
- Defined in packages/workflow/src/workflow.ts:76

Properties

`Readonly` name

name: string

next

next: { [ name in string | number | symbol]?: (keyof T & string)[] } = {}

`Readonly` places

places: T

symbol

symbol: symbol = ...

tokens

tokens: { [ name in string | number | symbol]?: EventToken<any> } = {}

transitions

transitions: WorkflowTransition<T>[] = []

Methods

addTransition

addTransition(from: keyof T & string, to: keyof T & string, label?: string): void
Parameters
- from: keyof T & string
- to: keyof T & string
- Optional label: string
Returns void
- Defined in packages/workflow/src/workflow.ts:104

buildApplier

buildApplier(eventDispatcher: EventDispatcher): Function
Parameters
- eventDispatcher: EventDispatcher
Returns Function
- Defined in packages/workflow/src/workflow.ts:118

create

create(state: keyof T & string, eventDispatcher: EventDispatcher, injector?: InjectorContext, stopwatch?: Stopwatch): Workflow<T>
Parameters
- state: keyof T & string
- eventDispatcher: EventDispatcher
- Optional injector: InjectorContext
- Optional stopwatch: Stopwatch
Returns Workflow<T>
- Defined in packages/workflow/src/workflow.ts:110

getEventToken

getEventToken<K>(name: K): EventToken<ExtractClassType<T[K]>>
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
Returns EventToken<ExtractClassType<T[K]>>
- Defined in packages/workflow/src/workflow.ts:98

getTransitionsFrom

getTransitionsFrom(state: keyof T & string): (keyof T & string)[]
Parameters
- state: keyof T & string
Returns (keyof T & string)[]
- Defined in packages/workflow/src/workflow.ts:114

Generated using TypeDoc