LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
React SDK
Vue SDK
Svelte SDK
Angular SDK
LangGraph SDK
  • Ui
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Utils
  • Server
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
  • Store
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
WebChannelsPregelPrebuiltRemote
React SDK
Vue SDK
Svelte SDK
Angular SDK
LangGraph SDK
UiClientAuthReactLoggingReact UiUtilsServer
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
Store
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/langgraph-sdkclientSubscriptionHandle
Classā—Since v2.0

SubscriptionHandle

Copy
class SubscriptionHandle

Constructors

Properties

Methods

View source on GitHub
constructor
constructor
property
params: SubscribeParams
property
subscriptionId: string
property
isPaused: boolean
method
[asyncIterator]→ AsyncIterator<TYield>
method
close→ Promise<void>

Shuts down the transport and releases any underlying resources.

method
pause

Pause the subscription: resolve all waiting iterators with done: true so for await loops exit, but keep the subscription alive. New events arriving while paused are still buffered. Call resume() to allow iterators to consume again.

method
push
method
resume

Resume a paused subscription so new for await loops can consume buffered and future events.

method
unsubscribe→ Promise<void>
method
waitForResume→ Promise<void>

Returns a promise that resolves when resume() is called. Resolves immediately if not currently paused.

Async iterable handle for raw event subscriptions.

An optional transform maps each incoming event before it is queued or delivered to a waiting consumer. This is used by named custom channel subscriptions (e.g. "custom:a2a") to unwrap the payload so callers receive the raw emitted data instead of the protocol event envelope.