Menu
Language
Theme
Streams the execution of the graph, emitting state updates as they occur. This is the primary method for observing graph execution in real-time.
Stream modes:
stream<
TStreamMode extends StreamMode | StreamMode[] | undefined,
TSubgraphs extends boolean,
TEncoding extends "text/event-stream" | undefined
>(
input: ExtractUpdateType<I, ExtractStateType<I, I>> | CommandInstance<InferInterruptResumeType<InterruptType, false>, { [K in string | number | symbol]: U[K] }, N> | null,
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, ExtractStateType<C, C> Record<string, any>, TStreamMode, TSubgraphs, TEncoding>>
): Promise<IterableReadableStream<StreamOutputMap<TStreamMode, TSubgraphs, ExtractUpdateType<I, ExtractStateType<I, I>>, ExtractStateType<O, O>, "__start__" | N, NodeReturnType, InferWriterType<WriterType>, TEncoding>>>| Name | Type | Description |
|---|---|---|
input* | ExtractUpdateType<I, ExtractStateType<I, I>> | CommandInstance<InferInterruptResumeType<InterruptType, false>, { [K in string | number | symbol]: U[K] }, N> | null | The input to start graph execution with |
options | Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, ExtractStateType<C, C> & Record<string, any>, TStreamMode, TSubgraphs, TEncoding>> | Configuration options for streaming |