LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
  • Stream
LangGraph SDK
  • Ui
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Utils
  • Server
  • Stream
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
WebChannelsPregelPrebuiltRemoteStream
LangGraph SDK
UiClientAuthReactLoggingReact UiUtilsServerStream
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-sdkstreamacquireChannelEffect
Functionā—Since v1.9

acquireChannelEffect

Acquire a side-effect subscription over one or more channels.

Copy
acquireChannelEffect(
  registry: ChannelRegistry,
  channels: readonly Channel[],
  namespace: readonly string[],
  options: ChannelEffectOptions): (
) => void

Parameters

NameTypeDescription
registry*ChannelRegistry

The stream's ChannelRegistry.

channels*readonly Channel[]

Channels to observe (e.g. ["lifecycle", "tools"]).

namespace*readonly string[]

Resolved namespace ([] for the root).

options*ChannelEffectOptions

Callbacks plus projection (bufferSize/replay) options.

View source on GitHub