Function: runWorkflow()#

function runWorkflow(options): AsyncIterable<WorkflowEvent>;

function runWorkflow(options): AsyncIterable<WorkflowEvent>;

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

Drive a workflow to completion or pause. Returns an AsyncIterable of every event the engine appends to the run's log, in order.

The same events are simultaneously persisted via runStore.appendEvent — the iterable and the persisted log share one shape (the log IS the transport).

Parameters#

options#

RunWorkflowOptions

Returns#

AsyncIterable<WorkflowEvent>