Workflow

Defined in: packages/core/src/workflow/workflow.ts:18

Constructors

Constructor

new Workflow(params): Workflow

Defined in: packages/core/src/workflow/workflow.ts:29

Parameters

params

verbose?

boolean

timeout?

number

validate?

boolean

ignoreDeprecatedWarning?

boolean

Returns

Workflow

Methods

addStep()

addStep<T>(eventType, method, params): void

Defined in: packages/core/src/workflow/workflow.ts:53

Type Parameters

T

T extends WorkflowEvent<any>

Parameters

eventType

EventTypeParam

method

StepFunction<T>

params

outputs?

EventTypeParam

Returns

void

---

hasStep()

hasStep(step): boolean

Defined in: packages/core/src/workflow/workflow.ts:68

Parameters

step

StepFunction<any>

Returns

boolean

---

streamEvents()

streamEvents(): AsyncGenerator<WorkflowEvent<any>, void>

Defined in: packages/core/src/workflow/workflow.ts:82

Returns

AsyncGenerator<WorkflowEvent<any>, void>

---

validate()

validate(): void

Defined in: packages/core/src/workflow/workflow.ts:98

Returns

void

---

run()

run<T>(event): Promise<StopEvent<string>>

Defined in: packages/core/src/workflow/workflow.ts:151

Type Parameters

T

T = string

Parameters

event

string | StartEvent<T>

Returns

Promise<StopEvent<string>>