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

LangChain Assistant

Ask a question to get started

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/langgraphstreamProtocolEvent
Interface●Since v1.3

ProtocolEvent

Single envelope for a streaming protocol emission: sequence, channel (method), and payload (params).

Copy
interface ProtocolEvent

Used in Docs

  • Custom stream channels

Properties

property
method: ProtocolMethod

Logical stream channel. Built-in channels match StreamMode (e.g. messages, updates); transformer-synthesized channels include lifecycle and input; user-defined channels carry their StreamChannel.channelName.

property
params: __type

Channel-specific payload and routing metadata.

property
seq: number

Monotonic sequence number for ordering and deduplication within a run.

property
type: "event"

Discriminator; always "event" for this shape.

View source on GitHub