Workflow

Defined in: workflow/src/workflow.ts:24

Type Parameters

• ContextData

• Start

• Stop

Constructors

new Workflow()

new Workflow<ContextData, Start, Stop>(params): Workflow<ContextData, Start, Stop>

Defined in: workflow/src/workflow.ts:37

Parameters

params

verbose?

boolean

timeout?

null | number

wait?

Wait

Returns

Workflow<ContextData, Start, Stop>

Methods

addStep()

addStep<In, Out>(parameters, stepFn): this

Defined in: workflow/src/workflow.ts:55

Type Parameters

• In extends [AnyWorkflowEventConstructor | StartEventConstructor, ...(AnyWorkflowEventConstructor | StopEventConstructor)[]]

• Out extends (AnyWorkflowEventConstructor | StopEventConstructor)[]

Parameters

parameters

StepParameters<In, Out>

stepFn

(context, ...events) => Promise<Out extends [] ? void : { [K in string | number | symbol]: InstanceType<Out[K<K>]> }[number]>

Returns

this

---

hasStep()

hasStep(stepFn): boolean

Defined in: workflow/src/workflow.ts:81

Parameters

stepFn

StepHandler

Returns

boolean

---

removeStep()

removeStep(stepFn): this

Defined in: workflow/src/workflow.ts:85

Parameters

stepFn

StepHandler

Returns

this

---

run()

Call Signature

run(event): unknown extends ContextData ? WorkflowContext<Start, Stop, ContextData> : WorkflowContext<Start, Stop, undefined | ContextData>

Defined in: workflow/src/workflow.ts:90

Parameters

event

Start | StartEvent<Start>

Returns

unknown extends ContextData ? WorkflowContext<Start, Stop, ContextData> : WorkflowContext<Start, Stop, undefined | ContextData>

Call Signature

run<Data>(event, data): WorkflowContext<Start, Stop, Data>

Defined in: workflow/src/workflow.ts:95

Type Parameters

• Data

Parameters

event

Start | StartEvent<Start>

data

Data

Returns

WorkflowContext<Start, Stop, Data>

---

recover()

recover(data): WorkflowContext<Start, Stop, ContextData>

Defined in: workflow/src/workflow.ts:120

Parameters

data

ArrayBuffer

Returns

WorkflowContext<Start, Stop, ContextData>