mirror of
https://github.com/langchain-ai/langgraph.git
synced 2026-08-26 09:32:25 +02:00
28 lines
754 B
Markdown
28 lines
754 B
Markdown
[**@langchain/langgraph-sdk**](../README.md)
|
|
|
|
***
|
|
|
|
[@langchain/langgraph-sdk](../README.md) / useStream
|
|
|
|
# Function: useStream()
|
|
|
|
> **useStream**\<`StateType`, `Bag`\>(`options`): [`UseStream`](../interfaces/UseStream.md)\<`StateType`, `Bag`\>
|
|
|
|
Defined in: [react/stream.tsx:652](https://github.com/langchain-ai/langgraph/blob/a7ea5e44ce12e3618d1a766587163afbfe424e04/libs/sdk-js/src/react/stream.tsx#L652)
|
|
|
|
## Type Parameters
|
|
|
|
• **StateType** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
|
|
|
|
• **Bag** *extends* `object` = `BagTemplate`
|
|
|
|
## Parameters
|
|
|
|
### options
|
|
|
|
[`UseStreamOptions`](../interfaces/UseStreamOptions.md)\<`StateType`, `Bag`\>
|
|
|
|
## Returns
|
|
|
|
[`UseStream`](../interfaces/UseStream.md)\<`StateType`, `Bag`\>
|