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

Vite plugin for React Server Components (RSC)

import type { CreateRscStreamFn } from "./createRscStream.types.js";
/**
 * Creates an RSC stream using the server-side render handler.
 *
 * **Purpose**: Creates RSC streams directly in the server environment without worker threads.
 * **When to use**:
 * - You're in a server environment (Node.js server)
 * - You want to create RSC streams synchronously without worker overhead
 * - You need RSC streams for server-side rendering or API responses
 * - You're in a development server and want direct RSC generation
 *
 * **Flow**: Route + Components → RSC Stream (direct server rendering)
 *
 * @example
 * ```typescript
 * // Create RSC stream for server-side rendering
 * const rscStream = createRscStream({
 *   route: "/api/data",
 *   PageComponent: DataPage,
 *   RootComponent: RootLayout,
 *   HtmlComponent: React.Fragment, // Headless for API
 *   pageProps: { data: apiData },
 *   logger: myLogger,
 * });
 *
 * // Pipe to response
 * rscStream.pipe(response);
 * ```
 *
 * @example
 * ```typescript
 * // Create full RSC with HTML wrapper
 * const rscFull = createRscStream({
 *   route: "/about",
 *   PageComponent: AboutPage,
 *   RootComponent: RootLayout,
 *   HtmlComponent: HtmlDocument, // Full HTML wrapper
 *   pageProps: { title: "About Us" },
 * });
 * ```
 *
 * @param options - Options for RSC stream creation
 * @returns RSC stream with pipe/abort interface
 */
export declare const createRscStream: CreateRscStreamFn<"server">;
//# sourceMappingURL=createRscStream.server.d.ts.map