vite-plugin-react-server
Version:
Vite plugin for React Server Components (RSC)
45 lines • 1.63 kB
TypeScript
import type { CreateRenderToPipeableStreamHandlerFn } from "./createRenderToPipeableStreamHandler.types.js";
/**
* Creates an RSC stream from React elements using ReactDOMServer.renderToPipeableStream.
*
* **Purpose**: Converts React elements to React Server Components (RSC) format for server-side rendering.
* **When to use**:
* - You have React elements and need to create RSC streams
* - You're in a server environment (Node.js server or server-side worker)
* - You need to create .rsc files or serve RSC content
* - You want to serialize React components for client-side hydration
*
* **Flow**: React Elements → RSC Stream
*
* @example
* ```typescript
* // Create RSC stream from React elements
* const rscHandler = createRenderToPipeableStreamHandler({
* route: "/about",
* PageComponent: AboutPage,
* RootComponent: RootLayout,
* HtmlComponent: HtmlDocument,
* pageProps: { title: "About Us" },
* logger: myLogger,
* });
*
* // Pipe to file or response
* rscHandler.pipe(fileStream);
* ```
*
* @example
* ```typescript
* // Create headless RSC (no HTML wrapper)
* const rscHeadless = createRenderToPipeableStreamHandler({
* route: "/about",
* PageComponent: AboutPage,
* HtmlComponent: React.Fragment, // No HTML wrapper
* pageProps: { title: "About Us" },
* });
* ```
*
* @param handlerOptions - Options for RSC stream creation
* @returns RSC stream with pipe/abort interface
*/
export declare const createRenderToPipeableStreamHandler: CreateRenderToPipeableStreamHandlerFn<"server">;
//# sourceMappingURL=createRenderToPipeableStreamHandler.server.d.ts.map