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
  • 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
WebChannelsPregelPrebuiltRemote
React SDK
Vue SDK
Svelte SDK
Angular SDK
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/reactuseValues
Function●Since v1.0

useValues

Copy
useValues<StateType extends object>(stream: StreamHandle<StateType>): StateType
View source on GitHub

Parameters

NameTypeDescription
stream*StreamHandle<StateType>

Subscribe to a scoped values stream — most-recent state payload for a namespace. Equivalent to reading stream.values at the root.

When the payload carries a messages array, it is coerced to BaseMessage instances to keep parity with the root projection.

Typing:

  • Root (useValues(stream)): returns the StateType declared on the parent useStream<State>() — no explicit generic required. Non-nullable because the root snapshot always carries values (falling back to initialValues ?? {}).
  • Scoped (useValues(stream, target)): the scoped payload can have a different shape than the root state (e.g. a subagent returning its own substate). Callers should annotate the expected shape explicitly: useValues<SubagentState>(stream, sub). Defaults to unknown when not annotated.