Cereal docs
TypeScript SDKTypeScript signatures

toUIMessageStream

Public TypeScript declaration from @trycereal/sdk/browser.

Import from @trycereal/sdk/browser. Generated from the repository SDK declarations (package version 0.0.0); not from HTTP request schemas.

export declare const toUIMessageStream: (options: {
    readonly tokenSource: () => Promise<StreamToken>;
    readonly lastEventId?: string;
    readonly signal?: AbortSignal;
    readonly fetch?: typeof globalThis.fetch;
    readonly onError?: (error: unknown) => void;
    readonly relabelUserTurns?: boolean;
}) => ReadableStream<AiSdkStreamChunk>;

See SDK setup, authoring, client behavior, and the API/SDK map for usage. Domain types are described in schema reference.

Related SDK types: StreamToken, AiSdkStreamChunk.