LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
  • Stream
LangGraph SDK
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Server
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
LangGraph Checkpoint Redis
  • Shallow
  • Store
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
  • Cli
LangGraph API
LangGraph CLI
LangGraph CUA
  • Utils
LangGraph Supervisor
LangGraph Swarm
⌘I

Chat LangChain

What can I help with?

Enter to send·Shift+Enter new line

Menu

LangGraph
WebChannelsPregelPrebuiltRemoteStream
LangGraph SDK
ClientAuthReactLoggingReact UiServer
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
LangGraph Checkpoint Redis
ShallowStore
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
Cli
LangGraph API
LangGraph CLI
LangGraph CUA
Utils
LangGraph Supervisor
LangGraph Swarm
Language
Theme
JavaScript@langchain/langgraphwebGraphRunStream
Class●Since v1.5

GraphRunStream

Primary run stream for a LangGraph execution.

Implements AsyncIterable over ProtocolEvent and exposes ergonomic projections for values, messages, subgraphs, output, and interrupts. Created by createGraphRunStream.

Copy
class GraphRunStream

Constructors

constructor
constructor→ GraphRunStream<TValues, TExtensions>

Properties

property
extensions: TExtensions

Merged projections from user-supplied StreamTransformer factories. Each transformer's init() return value is spread into this object.

property
path: Namespace

Namespace path identifying this stream's position in the agent tree. An empty array for the root stream.

property
interrupted: boolean
property
interrupts: readonly InterruptPayload<unknown>[]
property
lifecycle: AsyncIterable<LifecycleEntry>
property
messages: AsyncIterable<ChatModelStreamHandle>
property
output: Promise<TValues>
property
signal: AbortSignal
property
subgraphs: AsyncIterable<SubgraphRunStream<Record<string, unknown>, Record<string, unknown>>>
property
values: AsyncIterable<TValues, any, any> & PromiseLike<TValues>

Methods

method
[asyncIterator]→ AsyncIterator<ProtocolEvent>

Async iterator over all ProtocolEvents at or below this stream's namespace, starting from the configured event offset.

method
abort

Programmatically abort this run. Equivalent to calling signal.abort(reason).

method
messagesFrom→ AsyncIterable<ChatModelStreamHandle>

Messages produced by a specific graph node. Use when the run has multiple model-calling nodes and you only want messages from one.

View source on GitHub