Skip to main content

Run.observeStreamVNext() (Experimental)

The .observeStreamVNext() method opens a new ReadableStream to a workflow run that is currently running, allowing you to observe the stream of events if the original stream is no longer available.

Usage example​

const run = await workflow.createRunAsync();

run.streamVNext({
  inputData: {
    value: "initial data",
  },
});

const stream = await run.observeStreamVNext();

for await (const chunk of stream) {
  console.log(chunk);
}

Returns​

ReadableStream<ChunkType>

Stream Events​

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

  • workflow-start: Workflow execution begins
  • workflow-step-start: A step begins execution
  • workflow-step-output: Custom output from a step
  • workflow-step-result: A step completes with results
  • workflow-finish: Workflow execution completes with usage statistics