vite-plugin-react-server/dist/plugin/stream/createRscStream.types.d.ts

Vite plugin for React Server Components (RSC)

import type { StreamMetrics } from "../helpers/metrics.js";
import type { Stream } from "node:stream";
import type { OnMetrics, PanicThreshold } from "../types.js";
import type { SerializableHandlerOptions } from "../helpers/createSerializableHandlerOptions.js";
/**
 * Base RSC Stream Result - common interface for both client and server
 */
export interface BaseRscStreamResult {
    id: string;
    rscStream: Stream.Readable;
    pipe: <Writable extends NodeJS.WritableStream>(destination: Writable) => Writable;
    abort: (reason?: unknown) => void;
    metrics: StreamMetrics;
}
/**
 * Client-specific RSC Stream Result
 */
export interface ClientRscStreamResult extends BaseRscStreamResult {
    type: "client";
}
/**
 * Server-specific RSC Stream Result
 */
export interface ServerRscStreamResult extends BaseRscStreamResult {
    type: "server";
}
/**
 * RSC Stream Result - union type for both environments
 */
export type RscStreamResult = ClientRscStreamResult | ServerRscStreamResult;
/**
 * Client-specific RSC Stream Options
 */
export type ClientRscStreamOptions = SerializableHandlerOptions & {
    route: string;
    pagePath: string | undefined;
    projectRoot: string;
    moduleBaseURL: string;
    build: SerializableHandlerOptions['build'];
    dev: SerializableHandlerOptions['dev'];
    cssFiles: Map<string, any>;
    globalCss: Map<string, any>;
    manifest: any;
    id?: string;
    moduleRootPath?: string;
    moduleBasePath?: string;
    verbose?: boolean;
    panicThreshold?: PanicThreshold;
    propsPath?: string;
    rootPath?: string;
    htmlPath?: string;
    pageExportName: string;
    propsExportName: string;
    rootExportName: string;
    htmlExportName: string;
    moduleBase: string;
    publicOrigin: string;
    rscTimeout: number;
    rscWorker?: any;
    htmlWorker?: any;
    htmlWorkerPath?: string;
    rscWorkerPath?: string;
    worker?: any;
    clientPipeableStreamOptions?: any;
    serverPipeableStreamOptions?: any;
    url: string;
    onMetrics?: OnMetrics;
    onEvent?: (event: any) => void;
    reuseHeadlessStreamId?: string;
};
/**
 * Server-specific RSC Stream Options
 */
export interface ServerRscStreamOptions {
    route: string;
    pagePath: string;
    logger: any;
    loader: any;
    build: any;
    id?: string;
    projectRoot: string;
    moduleRootPath: string;
    moduleBasePath: string;
    moduleBaseURL: string;
    verbose: boolean;
    panicThreshold?: PanicThreshold;
    propsPath?: string;
    rootPath?: string;
    htmlPath?: string;
    pageExportName: string;
    propsExportName: string;
    rootExportName: string;
    htmlExportName: string;
    moduleBase: string;
    publicOrigin: string;
    rscTimeout: number;
    cssFiles: Map<string, any>;
    globalCss: Map<string, any>;
    manifest: any;
    worker?: any;
    rscWorker?: any;
    rscWorkerPath?: string;
    htmlWorker?: any;
    htmlWorkerPath?: string;
    clientPipeableStreamOptions?: any;
    serverPipeableStreamOptions?: any;
    url: string;
    htmlTimeout?: number;
    fileWriteTimeout?: number;
    workerShutdownTimeout?: number;
    css?: any;
    onEvent?: (event: any) => void;
}
/**
 * Environment-specific RSC Stream Options
 */
export type CreateRscStreamOptions<Env extends "client" | "server" = "client" | "server"> = Env extends "client" ? ClientRscStreamOptions : ServerRscStreamOptions;
/**
 * RSC Stream Function - creates React Server Components streams
 *
 * **Purpose**: Creates RSC streams for both client and server environments
 * **When to use**:
 * - You need to create RSC streams for static generation or server-side rendering
 * - You want environment-specific optimizations (worker-based vs direct rendering)
 * - You need to serialize React components for client-side hydration
 *
 * **Flow**: Route + Components → RSC Stream (with environment-specific processing)
 */
export type CreateRscStreamFn<Env extends "client" | "server" = "client" | "server"> = <Opt extends CreateRscStreamOptions<Env> = CreateRscStreamOptions<Env>>(options: Opt) => Env extends "client" ? ClientRscStreamResult : ServerRscStreamResult;
/**
 * Unified RSC Stream Function - automatically chooses environment
 */
export type CreateRscStreamFnUnified = <Env extends "client" | "server", Opt extends CreateRscStreamOptions<Env>>(options: Opt) => RscStreamResult;
//# sourceMappingURL=createRscStream.types.d.ts.map