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/vueuseValues
Function●Since v1.0

useValues

Subscribe to a scoped values stream — the most recent state payload for a namespace. At the root returns stream.values.

Typing:

  • Root (useValues(stream)): returns the StateType declared on useStream<State>() — non-nullable (the root snapshot always has values, falling back to initialValues ?? {}).
  • Scoped (useValues(stream, target)): scoped payloads can differ from the root state; callers should annotate the expected shape explicitly (useValues<SubagentState>(stream, sub)). Defaults to unknown when not annotated.
Copy
useValues<StateType extends object>(
  stream: StreamHandle<StateType>
): Readonly<ShallowRef<StateType>>

Parameters

NameTypeDescription
stream*StreamHandle<StateType>
View source on GitHub