@langchain/react is designed around agent-brand inference: pass typeof agent to the hook and get typed state, tool calls, and (for DeepAgents) subagent state maps back. Plain state generics still work for graphs that aren't built with the agent helpers.
Pass typeof agent to infer state, tool-call union, and (for DeepAgents) subagent state map:
import type { agent } from "./agent";
import { useStream } from "@langchain/react";
function Chat() {
const stream = useStream<typeof agent>({
assistantId: "agent",
apiUrl: "http://localhost:2024",
});
// stream.values is inferred
// stream.toolCalls is a discriminated union of your tools
// stream.subagents carries per-subagent state types
}
The same inference works on useStreamContext<typeof agent>() and on the companion selector hooks when you pass a scoped target:
const messages = useMessages(stream); // BaseMessage[]
const tools = useToolCalls<typeof agent>(stream);
const state = useValues<typeof agent>(stream);
For plain state shapes, pass the state directly. The second and third generic slots are InterruptType and ConfigurableType:
import { useStream } from "@langchain/react";
import type { BaseMessage } from "@langchain/core/messages";
interface MyState {
messages: BaseMessage[];
context?: string;
}
const stream = useStream<MyState, { question: string }>({
assistantId: "my-graph",
apiUrl: "http://localhost:2024",
});
Two type aliases cover the two common prop shapes:
UseStreamReturn<T> — fully-resolved return type. Use for { stream: UseStreamReturn<typeof agent> } props when the child needs typed access to state / tool calls. (UseStreamResult<T> is an alias of the same type.)AnyStream — type-erased handle (UseStreamReturn<any, any, any>). Use when the child only forwards stream into selector hooks and doesn't care about the underlying state shape.import type { AnyStream, UseStreamReturn } from "@langchain/react";
import type { agent } from "./agent";
function ChatPanel({ stream }: { stream: UseStreamReturn<typeof agent> }) {
// stream.values is typed here
}
function SubgraphCard({
stream,
subgraph,
}: {
stream: AnyStream;
subgraph: SubgraphDiscoverySnapshot;
}) {
// stream is only used to feed selector hooks — no generic required
}
| Helper | Use |
|---|---|
InferStateType<T> |
Unwraps a compiled graph / agent brand / agent tool array into its state shape. |
InferToolCalls<T> |
Derives a discriminated union of tool-call shapes. |
InferToolOutput<T> |
Derives a single tool's output type. |
InferSubagentStates<T> |
{ name: State, … } map derived from a DeepAgent brand. |
WidenUpdateMessages<T> |
Widens messages so both wire-format and BaseMessage instances typecheck in submit(). |
StreamSubmitOptions<State, Configurable> |
Options shape accepted by submit(). |
AgentServerAdapter / HttpAgentServerAdapter |
Custom-transport interface + convenience class. See Transports. |
SelectorTarget / SubagentDiscoverySnapshot / SubgraphDiscoverySnapshot |
For components that render scoped views. See Selectors / Subagents. |
AssembledToolCall, ToolCallStatus |
For rendering tool-call UI. |
MessageMetadata, UseSubmissionQueueReturn, SubmissionQueueEntry |
Companion-hook return shapes. See Selectors. |
Reactive tool handle for framework bindings (stream.toolCalls,
useToolCalls, injectToolCalls).
status, error, and output are plain values that the assembler updates in place as tool events arri
Metadata tracked per message id. Surfaced to applications via
useMessageMetadata(stream, messageId).
Unwrap the state shape from a compiled graph, a create-agent brand,
or a plain type. Used by useStream<T>() to resolve T = typeof agent into the state the values/messages projections observe.
Infer the discriminated union of AssembledToolCall handles from an agent brand, an array of LangChain tools, or fall back to the untyped default handle.
Pass typeof agent or typeof tools and narr
Infer the successful return type of a LangChain tool.
Resolution order mirrors InferToolInput: func, then
invoke, then _call, so inference survives cross-package
boundaries where _call is `pr
Infer the subagent → state map from a DeepAgent brand. Non-brands collapse to DefaultSubagentStates.
Widen an update type so its messages field also accepts
@langchain/core BaseMessage class instances (single or
array). Framework bindings apply this to submit() so callers can
write `stream.subm
Convenience alias for the fully-resolved stream handle type.
Erased stream handle useful as a parameter type for helpers and
wrapper components that pass a stream through to selector hooks
(useMessages, useChannel, …) without reading values directly.
A
High-level outcome of a single tool call.
The lifecycle state of a tool call.
pending: Tool call received, awaiting resultcompleted: Tool execution finished successfullyerror: Tool execution failed (result.status === "error")Default tool call type when no specific tool definitions are provided.
Infer a union of tool call types from an array of tools.
Works with tools created via tool() from @langchain/core/tools.
Read-only map exposed via MessageMetadataTracker.store.