ai
Version:
AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript
47 lines (31 loc) • 1.37 kB
text/mdx
title: useStreamableValue
description: Reference for the useStreamableValue function from the AI SDK RSC
# `useStreamableValue`
<Note type="warning">
AI SDK RSC is currently experimental. We recommend using [AI SDK
UI](/docs/ai-sdk-ui/overview) for production. For guidance on migrating from
RSC to UI, see our [migration guide](/docs/ai-sdk-rsc/migrating-to-ui).
</Note>
It is a React hook that takes a streamable value created using [`createStreamableValue`](/docs/reference/ai-sdk-rsc/create-streamable-value) and returns the current value, error, and pending state.
## Import
<Snippet
text={`import { useStreamableValue } from "@ai-sdk/rsc"`}
prompt={false}
/>
## Example
This is useful for consuming streamable values received from a component's props.
```tsx
function MyComponent({ streamableValue }) {
const [data, error, pending] = useStreamableValue(streamableValue);
if (pending) return <div>Loading...</div>;
if (error) return <div>Error: {error.message}</div>;
return <div>Data: {data}</div>;
}
```
## API Signature
### Parameters
It accepts a streamable value created using `createStreamableValue`.
### Returns
It is an array, where the first element contains the data, the second element contains an error if it is thrown anytime during the stream, and the third is a boolean indicating if the value is pending.