Interface: RunWorkflowOptions#

Defined in: packages/workflow-core/src/engine/run-workflow.ts:27

Properties#

approval?#

optional approval: ApprovalResult;

optional approval: ApprovalResult;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:35

attach?#

optional attach: boolean;

optional attach: boolean;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:37

Read-only subscription to an existing run.

input?#

optional input: unknown;

optional input: unknown;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:32

Start: provide input. Resume: provide runId plus a delivery (signalDelivery or approval). Attach: runId + attach: true.

outputSink()?#

optional outputSink: (output) => void;

optional outputSink: (output) => void;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:48

Called with the workflow's final output before the run record is cleaned up.

Parameters#

output#

unknown

Returns#

void

publish()?#

optional publish: (runId, event) => void | Promise<void>;

optional publish: (runId, event) => void | Promise<void>;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:45

Hook called for every event the engine appends. Hosts wire this to a fan-out transport (Redis, Durable Streams, EventBridge) so subscribers on other nodes can tail the run.

Parameters#

runId#

string

event#

WorkflowEvent

Returns#

void | Promise<void>

runId?#

optional runId: string;

optional runId: string;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:33

runStore#

runStore: RunStore;

runStore: RunStore;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:29

signal?#

optional signal: AbortSignal;

optional signal: AbortSignal;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:39

External cancellation.

signalDelivery?#

optional signalDelivery: SignalDelivery<unknown>;

optional signalDelivery: SignalDelivery<unknown>;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:34

threadId?#

optional threadId: string;

optional threadId: string;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:41

Thread ID for client-side correlation.

workflow#

workflow: AnyWorkflowDefinition;

workflow: AnyWorkflowDefinition;

Defined in: packages/workflow-core/src/engine/run-workflow.ts:28