vue3-chat-yz/types/hooks/useStream_orgign.d.ts

vue3-chat-yz

/**
 * @link https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#fields
 */
export type SSEFields = "data" | "event" | "id" | "retry";
/**
 * @example
 * const sseObject = {
 *    event: 'delta',
 *    data: '{ key: "world!" }',
 * };
 */
export type SSEOutput = Partial<Record<SSEFields, any>>;
export interface ArtStreamOptions<Output> {
    /**
     * @description 可读的二进制数据流
     * @link https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
     */
    readableStream: ReadableStream<Uint8Array>;
    /**
     * @description 支持可定制的transformStream来转换流
     * @default sseTransformStream
     * @link https://developer.mozilla.org/en-US/docs/Web/API/TransformStream
     */
    transformStream?: TransformStream<string, Output>;
}