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

UseStreamReturn

Copy
interface UseStreamReturn

Properties

Methods

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

Return shape of useStream — the Angular StreamApi.

Reactivity primitives follow Angular conventions:

  • Data projections are Signal<T>; call them as functions in templates (stream.messages()). They are snapshots — never mutate the returned arrays / maps.
  • Imperative methods (submit / stop / respond) are plain functions. No WritableSignals are exposed on the root handle.
  • Identity values captured at construction time (client, assistantId) are exposed as plain values; remount the component to swap them.

Promise that settles when the active thread's initial hydration completes. Exposed so SSR/render-before-flush pipelines can await stream.hydrationPromise before serialising.

v2 escape hatch — returns the bound ThreadStream.