Class CompiledStateGraph<S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Final result from building and compiling a StateGraph. Should not be instantiated directly, only using the StateGraph .compile() instance method.

Type Parameters

S
U
N extends string = typeof START
I extends SDZod = StateDefinition
O extends SDZod = StateDefinition
C extends SDZod = StateDefinition
NodeReturnType = unknown
InterruptType = unknown
WriterType = unknown

Hierarchy (View Summary)

CompiledGraph<
 N,
 S,
 U,
 StateType<ToStateDefinition<C>>,
 UpdateType<ToStateDefinition>,
 StateType<ToStateDefinition<O>>,
 NodeReturnType,
 CommandInstance<InferInterruptResumeType<InterruptType>, Prettify, N>,
 InferWriterType<WriterType>,
>
- CompiledStateGraph

Constructors

constructor

new CompiledStateGraph<
 S,
 U,
 N extends string = "__start__",
 I extends SDZod = StateDefinition,
 O extends SDZod = StateDefinition,
 C extends SDZod = StateDefinition,
 NodeReturnType = unknown,
 InterruptType = unknown,
 WriterType = unknown,
>(
 __namedParameters: { description?: string } & {
 builder: Graph<N, S, U>;
 } & PregelParams<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 >,
): CompiledStateGraph<
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Type Parameters
- S
- U
- N extends string = "__start__"
- I extends SDZod = StateDefinition
- O extends SDZod = StateDefinition
- C extends SDZod = StateDefinition
- NodeReturnType = unknown
- InterruptType = unknown
- WriterType = unknown
Parameters
- __namedParameters: { description?: string } & { builder: Graph<N, S, U> } & PregelParams<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 >
Returns CompiledStateGraph<S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
Overrides CompiledGraph< N, S, U, StateType<ToStateDefinition<C>>, UpdateType<ToStateDefinition>, StateType<ToStateDefinition<O>>, NodeReturnType, CommandInstance<InferInterruptResumeType<InterruptType>, Prettify, N>, InferWriterType<WriterType> >.constructor
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:1047

Properties

~NodeReturnType

"~NodeReturnType": NodeReturnType

~NodeType

"~NodeType": N

~RunInput

"~RunInput": U

~RunOutput

"~RunOutput": S

autoValidate

autoValidate: boolean = true

Whether to automatically validate the graph structure when it is compiled. Defaults to true.

builder

builder: StateGraph<unknown, S, U, N, I, O, C, NodeReturnType>

`Optional`cache

cache?: any

Optional cache for the graph, useful for caching tasks.

channels

channels: Channels

The channels in the graph, mapping channel names to their BaseChannel or ManagedValueSpec instances

`Optional`checkpointer

checkpointer?: any

Optional checkpointer for persisting graph state. When provided, saves a checkpoint of the graph state at every superstep. When false or undefined, checkpointing is disabled, and the graph will not be able to save or restore state.

`Optional`config

config?: LangGraphRunnableConfig<Record<string, any>>

The default configuration for graph execution, can be overridden on a per-invocation basis

debug

debug: boolean = false

Whether to enable debug logging. Defaults to false.

`Optional`description

description?: string

The description of the compiled graph. This is used by the supervisor agent to describe the handoff to the agent.

inputChannels

inputChannels: string | N | (string | N)[]

The input channels for the graph. These channels receive the initial input when the graph is invoked. Can be a single channel key or an array of channel keys.

`Optional`interruptAfter

interruptAfter?: any

Optional array of node names or "all" to interrupt after executing these nodes. Used for implementing human-in-the-loop workflows.

`Optional`interruptBefore

interruptBefore?: any

Optional array of node names or "all" to interrupt before executing these nodes. Used for implementing human-in-the-loop workflows.

nodes

nodes: Nodes

The nodes in the graph, mapping node names to their PregelNode instances

outputChannels

outputChannels: string | N | (string | N)[]

The output channels for the graph. These channels contain the final output when the graph completes. Can be a single channel key or an array of channel keys.

`Optional`retryPolicy

retryPolicy?: RetryPolicy

Optional retry policy for handling failures in node execution

`Optional`stepTimeout

stepTimeout?: number

Optional timeout in milliseconds for the execution of each superstep

`Optional`store

store?: any

Optional long-term memory store for the graph, allows for persistence & retrieval of data across threads

`Optional`streamChannels

streamChannels?: string | N | (string | N)[]

Optional channels to stream. If not specified, all channels will be streamed. Can be a single channel key or an array of channel keys.

streamMode

streamMode: StreamMode[] = ...

The streaming modes enabled for this graph. Defaults to ["values"]. Supported modes:

"values": Streams the full state after each step
"updates": Streams state updates after each step
"messages": Streams messages from within nodes
"custom": Streams custom events from within nodes
"debug": Streams events related to the execution of the graph - useful for tracing & debugging graph execution

Accessors

streamChannelsAsIs

get streamChannelsAsIs(): keyof Channels | (keyof Channels)[]
Gets the channels to stream in their original format. If streamChannels is specified, returns it as-is (either single key or array). Otherwise, returns all channels in the graph as an array.

Returns keyof Channels | (keyof Channels)[]
Channel keys to stream, either as a single key or array
Inherited from CompiledGraph.streamChannelsAsIs
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:649

streamChannelsList

get streamChannelsList(): (keyof Channels)[]
Gets a list of all channels that should be streamed. If streamChannels is specified, returns those channels. Otherwise, returns all channels in the graph.

Returns (keyof Channels)[]
Array of channel keys to stream
Inherited from CompiledGraph.streamChannelsList
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:632

Methods

attachBranch

attachBranch(
 start: "__start__" | N,
 _: string,
 branch: Branch<S, N>,
 options?: { withReader?: boolean },
): void
Parameters
- start: "__start__" | N
- _: string
- branch: Branch<S, N>
- options: { withReader?: boolean } = ...
Returns void
Overrides CompiledGraph.attachBranch
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:1247

attachEdge

attachEdge(starts: "__start__" | N | N[], end: "__end__" | N): void
Parameters
- starts: "__start__" | N | N[]
- end: "__end__" | N
Returns void
Overrides CompiledGraph.attachEdge
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:1218

attachNode

attachNode(key: "__start__", node?: undefined): void
Parameters
- key: "__start__"
- Optionalnode: undefined
Returns void
Overrides CompiledGraph.attachNode
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:1067
attachNode(key: N, node: StateGraphNodeSpec<S, U>): void
Parameters
- key: N
- node: StateGraphNodeSpec<S, U>
Returns void
Overrides CompiledGraph.attachNode
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:1069

clearCache

clearCache(): Promise<void>
Returns Promise<void>
Inherited from CompiledGraph.clearCache
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:2314

getGraph

getGraph(
 config?: RunnableConfig<Record<string, any>> & {
 xray?: number | boolean;
 },
): Graph
Returns a drawable representation of the computation graph.
Parameters
- Optionalconfig: RunnableConfig<Record<string, any>> & { xray?: number | boolean }
Returns Graph
Deprecated
Use getGraphAsync instead. The async method will be the default in the next minor core release.
Inherited from CompiledGraph.getGraph
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:888

getGraphAsync

getGraphAsync(
 config?: RunnableConfig<Record<string, any>> & {
 xray?: number | boolean;
 },
): Promise<Graph>
Returns a drawable representation of the computation graph.
Parameters
- Optionalconfig: RunnableConfig<Record<string, any>> & { xray?: number | boolean }
Returns Promise<Graph>
Inherited from CompiledGraph.getGraphAsync
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:689

getState

getState(
config: RunnableConfig,
options?: GetStateOptions,
): Promise<StateSnapshot>
Gets the current state of the graph. Requires a checkpointer to be configured.
Parameters
- config: RunnableConfig
 Configuration for retrieving the state
- Optionaloptions: GetStateOptions
 Additional options
Returns Promise<StateSnapshot>
A snapshot of the current graph state

Throws
If no checkpointer is configured
Inherited from CompiledGraph.getState
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:938

getStateHistory

getStateHistory(
config: RunnableConfig,
options?: any,
): AsyncIterableIterator<StateSnapshot>
Gets the history of graph states. Requires a checkpointer to be configured. Useful for:
- Debugging execution history
- Implementing time travel
- Analyzing graph behavior
Parameters
- config: RunnableConfig
 Configuration for retrieving the history
- Optionaloptions: any
 Options for filtering the history
Returns AsyncIterableIterator<StateSnapshot>
An async iterator of state snapshots

Throws
If no checkpointer is configured
Inherited from CompiledGraph.getStateHistory
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:1000

getSubgraphs

getSubgraphs(
 namespace?: string,
 recurse?: boolean,
): Generator<
 [
 string,
 Pregel<
 any,
 any,
 StrRecord<string, any>,
 any,
 any,
 any,
 any,
 unknown,
 CommandInstance<unknown, Record<string, unknown>, string>,
 any,
 >,
 ],
>
Gets all subgraphs within this graph. A subgraph is a Pregel instance that is nested within a node of this graph.
Parameters
- Optionalnamespace: string
 Optional namespace to filter subgraphs
- Optionalrecurse: boolean
 Whether to recursively get subgraphs of subgraphs
Returns Generator<
 [
 string,
 Pregel<
 any,
 any,
 StrRecord<string, any>,
 any,
 any,
 any,
 any,
 unknown,
 CommandInstance<unknown, Record<string, unknown>, string>,
 any,
 >,
 ],
>
Generator yielding tuples of [name, subgraph]

Deprecated
Use getSubgraphsAsync instead. The async method will become the default in the next minor release.
Inherited from CompiledGraph.getSubgraphs
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:677

getSubgraphsAsync

getSubgraphsAsync(
 namespace?: string,
 recurse?: boolean,
): AsyncGenerator<
 [
 string,
 Pregel<
 any,
 any,
 StrRecord<string, any>,
 any,
 any,
 any,
 any,
 unknown,
 CommandInstance<unknown, Record<string, unknown>, string>,
 any,
 >,
 ],
>
Gets all subgraphs within this graph asynchronously. A subgraph is a Pregel instance that is nested within a node of this graph.
Parameters
- Optionalnamespace: string
 Optional namespace to filter subgraphs
- Optionalrecurse: boolean
 Whether to recursively get subgraphs of subgraphs
Returns AsyncGenerator<
 [
 string,
 Pregel<
 any,
 any,
 StrRecord<string, any>,
 any,
 any,
 any,
 any,
 unknown,
 CommandInstance<unknown, Record<string, unknown>, string>,
 any,
 >,
 ],
>
AsyncGenerator yielding tuples of [name, subgraph]
Inherited from CompiledGraph.getSubgraphsAsync
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:736

invoke

invoke(
 input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >,
 options?: Partial<
 Omit<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 undefined | StreamMode | StreamMode[],
 boolean,
 undefined | "text/event-stream",
 >,
 "encoding",
 >,
 >,
): Promise<StateType<ToStateDefinition<O>>>
Run the graph with a single input and config.
Parameters
- input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >
 The input to the graph.
- Optionaloptions: Partial<
 Omit<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 undefined | StreamMode | StreamMode[],
 boolean,
 undefined | "text/event-stream",
 >,
 "encoding",
 >,
 >
 The configuration to use for the run.
Returns Promise<StateType<ToStateDefinition<O>>>
Inherited from CompiledGraph.invoke
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:2202

isInterrupted

isInterrupted(
input: unknown,
): input is {
__interrupt__: Interrupt<InferInterruptInputType<InterruptType>>[];
}
Parameters
- input: unknown
Returns input is { __interrupt__: Interrupt<InferInterruptInputType<InterruptType>>[] }
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:1319

stream

stream<
 TStreamMode extends undefined
 | StreamMode
 | StreamMode[],
 TSubgraphs extends boolean,
 TEncoding extends undefined | "text/event-stream",
>(
 input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >,
 options?: Partial<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 TStreamMode,
 TSubgraphs,
 TEncoding,
 >,
 >,
): Promise<
 IterableReadableStream<
 StreamOutputMap<
 TStreamMode,
 TSubgraphs,
 UpdateType<ToStateDefinition>,
 StateType<ToStateDefinition<O>>,
 "__start__" | N,
 NodeReturnType,
 InferWriterType<WriterType>,
 TEncoding,
 >,
 >,
>
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:
- "values": Emits complete state after each step
- "updates": Emits only state changes after each step
- "debug": Emits detailed debug information
- "messages": Emits messages from within nodes
- "custom": Emits custom events from within nodes
- "checkpoints": Emits checkpoints from within nodes
- "tasks": Emits tasks from within nodes
Type Parameters
- TStreamMode extends undefined | StreamMode | StreamMode[]
- TSubgraphs extends boolean
- TEncoding extends undefined | "text/event-stream"
Parameters
- input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >
 The input to start graph execution with
- Optionaloptions: Partial<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 TStreamMode,
 TSubgraphs,
 TEncoding,
 >,
 >
 Configuration options for streaming
Returns Promise<
 IterableReadableStream<
 StreamOutputMap<
 TStreamMode,
 TSubgraphs,
 UpdateType<ToStateDefinition>,
 StateType<ToStateDefinition<O>>,
 "__start__" | N,
 NodeReturnType,
 InferWriterType<WriterType>,
 TEncoding,
 >,
 >,
>
An async iterable stream of graph state updates
Inherited from CompiledGraph.stream
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:1839

streamEvents

streamEvents(
 input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >,
 options: Partial<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 undefined | StreamMode | StreamMode[],
 boolean,
 undefined | "text/event-stream",
 >,
 > & { version: "v1" | "v2" },
 streamOptions?: Omit<EventStreamCallbackHandlerInput, "autoClose">,
): IterableReadableStream<StreamEvent>
Parameters
- input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >
- options: Partial<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 undefined | StreamMode | StreamMode[],
 boolean,
 undefined | "text/event-stream",
 >,
 > & { version: "v1" | "v2" }
- OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">
Returns IterableReadableStream<StreamEvent>
Inherit Doc
Inherited from CompiledGraph.streamEvents
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:1895
streamEvents(
 input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >,
 options: Partial<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 undefined | StreamMode | StreamMode[],
 boolean,
 undefined | "text/event-stream",
 >,
 > & { encoding: "text/event-stream"; version: "v1" | "v2" },
 streamOptions?: Omit<EventStreamCallbackHandlerInput, "autoClose">,
): IterableReadableStream<Uint8Array<ArrayBufferLike>>
Parameters
- input:
 | null
 | UpdateType<ToStateDefinition>
 | CommandInstance<
 InferInterruptResumeType<InterruptType, false>,
 { [K in string | number | symbol]: U[K] },
 N,
 >
- options: Partial<
 PregelOptions<
 Record<"__start__" | N, PregelNode<S, U>>,
 Record<string | N, BaseChannel<unknown, unknown, unknown>>,
 StateType<ToStateDefinition<C>> & Record<string, any>,
 undefined | StreamMode | StreamMode[],
 boolean,
 undefined | "text/event-stream",
 >,
 > & { encoding: "text/event-stream"; version: "v1" | "v2" }
- OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">
Returns IterableReadableStream<Uint8Array<ArrayBufferLike>>
Inherit Doc
Inherited from CompiledGraph.streamEvents
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:1903

updateState

updateState(
 inputConfig: LangGraphRunnableConfig,
 values: unknown,
 asNode?: string | N,
): Promise<RunnableConfig<Record<string, any>>>
Updates the state of the graph with new values. Requires a checkpointer to be configured.

This method can be used for:
- Implementing human-in-the-loop workflows
- Modifying graph state during breakpoints
- Integrating external inputs into the graph
Parameters
- inputConfig: LangGraphRunnableConfig
 Configuration for the update
- values: unknown
 The values to update the state with
- OptionalasNode: string | N
 Optional node name to attribute the update to
Returns Promise<RunnableConfig<Record<string, any>>>
Updated configuration

Throws
If no checkpointer is configured

Throws
If the update cannot be attributed to a node
Inherited from CompiledGraph.updateState
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:1681

validate

validate(): this
Validates the graph structure to ensure it is well-formed. Checks for:
- No orphaned nodes
- Valid input/output channel configurations
- Valid interrupt configurations
Returns this
this - The Pregel instance for method chaining

Throws
If the graph structure is invalid
Inherited from CompiledGraph.validate
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:604

withConfig

withConfig(
 config: Omit<LangGraphRunnableConfig, "store" | "writer" | "interrupt">,
): CompiledStateGraph<
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Creates a new instance of the Pregel graph with updated configuration. This method follows the immutable pattern - instead of modifying the current instance, it returns a new instance with the merged configuration.
Parameters
- config: Omit<LangGraphRunnableConfig, "store" | "writer" | "interrupt">
 The configuration to merge with the current configuration
Returns CompiledStateGraph<S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
A new Pregel instance with the merged configuration
Example
```
// Create a new instance with debug enabled
const debugGraph = graph.withConfig({ debug: true });

// Create a new instance with a specific thread ID
const threadGraph = graph.withConfig({
 configurable: { thread_id: "123" }
});
```
Inherited from CompiledGraph.withConfig
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/pregel/index.ts:586

Class CompiledStateGraph<S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CompiledStateGraph<S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Properties

~NodeReturnType

~NodeType

~RunInput

~RunOutput

autoValidate

builder

Optionalcache

channels

Optionalcheckpointer

Optionalconfig

debug

Optionaldescription

inputChannels

OptionalinterruptAfter

OptionalinterruptBefore

nodes

outputChannels

OptionalretryPolicy

OptionalstepTimeout

Optionalstore

OptionalstreamChannels

streamMode

Accessors

streamChannelsAsIs

Returns keyof Channels | (keyof Channels)[]

streamChannelsList

Returns (keyof Channels)[]

Methods

attachBranch

Parameters

Returns void

attachEdge

Parameters

Returns void

attachNode

Parameters

Returns void

Parameters

Returns void

clearCache

Returns Promise<void>

getGraph

Parameters

Returns Graph

Deprecated

getGraphAsync

Parameters

Returns Promise<Graph>

getState

Parameters

Returns Promise<StateSnapshot>

Throws

getStateHistory

Parameters

Returns AsyncIterableIterator<StateSnapshot>

Throws

getSubgraphs

Parameters

Returns Generator< [ string, Pregel< any, any, StrRecord<string, any>, any, any, any, any, unknown, CommandInstance<unknown, Record<string, unknown>, string>, any, >, ],>

Deprecated

getSubgraphsAsync

Parameters

Returns AsyncGenerator< [ string, Pregel< any, any, StrRecord<string, any>, any, any, any, any, unknown, CommandInstance<unknown, Record<string, unknown>, string>, any, >, ],>

invoke

Parameters

Returns Promise<StateType<ToStateDefinition<O>>>

`Optional`cache

`Optional`checkpointer

`Optional`config

`Optional`description

`Optional`interruptAfter

`Optional`interruptBefore

`Optional`retryPolicy

`Optional`stepTimeout

`Optional`store

`Optional`streamChannels

Returns Generator<
[
string,
Pregel<
any,
any,
StrRecord<string, any>,
any,
any,
any,
any,
unknown,
CommandInstance<unknown, Record<string, unknown>, string>,
any,
>,
],
>

Returns AsyncGenerator<
[
string,
Pregel<
any,
any,
StrRecord<string, any>,
any,
any,
any,
any,
unknown,
CommandInstance<unknown, Record<string, unknown>, string>,
any,
>,
],
>

Returns input is { interrupt: Interrupt<InferInterruptInputType<InterruptType>>[] }

Returns Promise<
IterableReadableStream<
StreamOutputMap<
TStreamMode,
TSubgraphs,
UpdateType<ToStateDefinition<I>>,
StateType<ToStateDefinition<O>>,
"start" | N,
NodeReturnType,
InferWriterType<WriterType>,
TEncoding,
>,
>,
>