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/vueUseStreamReturn
Interface●Since v1.0

UseStreamReturn

Copy
interface UseStreamReturn

Properties

Methods

View source on GitHub
property
assistantId: string
property
client: Client
property
error: ComputedRef<unknown>
property
hydrationPromise: ComputedRef<Promise<void>>
property
interrupt: ComputedRef<Interrupt<InterruptType> | undefined>
property
interrupts: Readonly<ShallowRef<Interrupt<InterruptType>[]>>
property
isLoading: ComputedRef<boolean>
property
isThreadLoading: ComputedRef<boolean>
property
messages: Readonly<ShallowRef<BaseMessage[]>>
property
subagents: Readonly<ShallowRef<ReadonlyMap<keyof SubagentStates & string extends never ? string : keyof SubagentStates & string, SubagentDiscoverySnapshot>>>
property
subgraphs: Readonly<ShallowRef<ReadonlyMap<string, SubgraphDiscoverySnapshot>>>
property
subgraphsByNode: Readonly<ShallowRef<ReadonlyMap<string, readonly SubgraphDiscoverySnapshot[]>>>
property
threadId: ComputedRef<string | null>
property
toolCalls: Readonly<ShallowRef<AssembledToolCall[]>>
property
values: Readonly<ShallowRef<StateType>>
method
getThread→ ThreadStream<Record<string, unknown>> | undefined
method
respond→ Promise<void>
method
stop→ Promise<void>
method
submit→ Promise<void>

Vue binding return type for useStream.

Reactive primitives follow Vue conventions:

  • Data projections are Readonly<ShallowRef<T>> / ComputedRef<T> so templates auto-unwrap via msg.value in <script setup> and directly in templates. They are snapshots — never mutate.
  • Imperative methods (submit / stop / respond) are plain functions — no refs involved.
  • Identity values captured at setup time (client / assistantId) are exposed as plain values; if you need to swap the bound agent or client, remount the composable.

Promise that settles when the active thread's initial hydration completes. Exposed so async setup() sites can await stream.hydrationPromise to implement a Suspense-like boundary.

v2 escape hatch — returns the bound ThreadStream.