Interface: BaseCtx<TInput, TState>

Defined in: packages/workflow-core/src/types.ts:301

Built-in fields on every ctx. Middleware can add fields via the TExtensions generic but cannot shadow these.

Type Parameters

TInput

TInput

TState

TState

Properties

approve()

approve: (options) => Promise<ApprovalResult>;

Defined in: packages/workflow-core/src/types.ts:320

Parameters

options

ApproveOptions

Returns

Promise<ApprovalResult>

emit()

emit: (name, value) => void;

Defined in: packages/workflow-core/src/types.ts:327

Emit a CUSTOM event for UI/devtools consumption. Does not enter the replay log.

Parameters

name

string

value

Record<string, unknown>

Returns

void

input

input: TInput;

Defined in: packages/workflow-core/src/types.ts:303

now()

now: (options?) => Promise<number>;

Defined in: packages/workflow-core/src/types.ts:321

Parameters

options?

DeterministicValueOptions

Returns

Promise<number>

runId

runId: string;

Defined in: packages/workflow-core/src/types.ts:302

signal

signal: AbortSignal;

Defined in: packages/workflow-core/src/types.ts:306

AbortSignal for the run as a whole.

sleep()

sleep: (ms, options?) => Promise<void>;

Defined in: packages/workflow-core/src/types.ts:314

Parameters

ms

number

options?

SleepOptions

Returns

Promise<void>

sleepUntil()

sleepUntil: (timestamp, options?) => Promise<void>;

Defined in: packages/workflow-core/src/types.ts:315

Parameters

timestamp

number

options?

SleepOptions

Returns

Promise<void>

state

state: TState;

Defined in: packages/workflow-core/src/types.ts:304

step()

step: <T>(id, fn, options?) => Promise<T>;

Defined in: packages/workflow-core/src/types.ts:309

Type Parameters

T

T

Parameters

id

string

fn

(stepCtx) => T | Promise<T>

options?

StepOptions

Returns

Promise<T>

uuid()

uuid: (options?) => Promise<string>;

Defined in: packages/workflow-core/src/types.ts:322

Parameters

options?

DeterministicValueOptions

Returns

Promise<string>

waitForEvent()

waitForEvent: <TPayload>(name, options?) => Promise<TPayload>;

Defined in: packages/workflow-core/src/types.ts:316

Type Parameters

TPayload

TPayload = unknown

Parameters

name

string

options?

WaitForEventOptions<TPayload>

Returns

Promise<TPayload>