createStreamableValue

Create a stream that sends values from the server to the client. The value can be any serializable data.

Import

import { createStreamableValue } from "@ai-sdk/rsc"

API Signature

Parameters

• value (any): Any data that RSC supports. Example, JSON.

Returns

• value (StreamableValue): The value of the streamable. This can be returned from a Server Action and received by the client. To read the streamed values, use the readStreamableValue or useStreamableValue APIs.

Methods

• update ((value: T) => StreamableValueWrapper): Updates the current value with a new one.
• append ((value: T) => StreamableValueWrapper): Appends a delta string to the current value. It requires the current value of the streamable to be a string.
• done ((value?: T) => StreamableValueWrapper): Marks the value as finalized. You can either call it without any parameters or with a new value as the final state. Once called, the value cannot be updated or appended anymore. This method is always required to be called, otherwise the response will be stuck in a loading state.
• error ((error: any) => StreamableValueWrapper): Signals that there is an error in the value stream. It will be thrown on the client side when consumed via readStreamableValue or useStreamableValue.