Run.stream()

The .stream() method allows you to monitor the execution of a workflow run, providing real-time updates on the status of steps.

Usage example


const run = await workflow.createRunAsync();
 
const stream = await run.stream({
  inputData: {
    value: "initial data",
  },
});

z.infer<TInput>

Input data that matches the workflow's input schema

RuntimeContext

Runtime context data to use during workflow execution

ReadableStream<StreamEvent>

A readable stream that emits workflow execution events in real-time

() => Promise<WorkflowResult<TOutput, TSteps>>

A function that returns a promise resolving to the final workflow result


const { getWorkflowState } = await run.stream({
  inputData: {
    value: "initial data"
  }
});
 
const result = await getWorkflowState();

The stream emits various event types during workflow execution. Each event has a type field and a payload containing relevant data: