AI SDK RSCcreateStreamableUI
createStreamableUI
Create a stream that sends UI from the server to the client. On the client side, it can be rendered as a normal React node.
Import
import { createStreamableUI } from "ai/rsc"
Arguments
initialValue?:
The initial value of the streamable UI.
Response Object
value:
The value of the streamable UI. This can be returned from a Server Action and received by the client.
Methods
update:
Updates the current UI node. It takes a new UI node and replaces the old one.
append:
Appends a new UI node to the end of the old one. Once appended a new UI node, the previous UI node cannot be updated anymore.
done:
Marks the UI node as finalized and closes the stream. Once called, the UI node 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:
Signals that there is an error in the UI stream. It will be thrown on the client side and caught by the nearest error boundary component.