Logo
Classes

Context

Defined in: packages/core/src/workflow/context.ts:4

Constructors

Constructor

new Context(params): Context

Defined in: packages/core/src/workflow/context.ts:14

Parameters

params
workflow

Workflow

verbose?

boolean

Returns

Context

Properties

running

running: boolean = true

Defined in: packages/core/src/workflow/context.ts:11

Methods

set()

set(key, value): void

Defined in: packages/core/src/workflow/context.ts:20

Parameters

key

string

value

any

Returns

void


get()

get(key, defaultValue?): any

Defined in: packages/core/src/workflow/context.ts:25

Parameters

key

string

defaultValue?

any

Returns

any


collectEvents()

collectEvents(event, expected): null | WorkflowEvent<any>[]

Defined in: packages/core/src/workflow/context.ts:34

Parameters

event

WorkflowEvent

expected

EventTypes[]

Returns

null | WorkflowEvent<any>[]


sendEvent()

sendEvent(message, step?): void

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

Parameters

message

WorkflowEvent

step?

StepFunction

Returns

void


getNextEvent()

getNextEvent(step): undefined | WorkflowEvent<any>

Defined in: packages/core/src/workflow/context.ts:89

Parameters

step

StepFunction

Returns

undefined | WorkflowEvent<any>


writeEventToStream()

writeEventToStream(event): void

Defined in: packages/core/src/workflow/context.ts:97

Parameters

event

WorkflowEvent

Returns

void


streamEvents()

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

Defined in: packages/core/src/workflow/context.ts:101

Returns

AsyncGenerator<WorkflowEvent<any>, void, void>