// forward declarations declare global { namespace NodeJS { // eslint-disable-next-line @typescript-eslint/no-empty-interface interface ReadableStream {} // eslint-disable-next-line @typescript-eslint/no-empty-interface interface WritableStream {} } /** * Stub for https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal */ // eslint-disable-next-line @typescript-eslint/no-empty-interface interface AbortSignal {} /** * Stub for https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream */ // eslint-disable-next-line @typescript-eslint/no-empty-interface interface ReadableStream {} } import { ReactNode } from "react"; import { ErrorInfo } from "./client"; export interface RenderToPipeableStreamOptions { identifierPrefix?: string; namespaceURI?: string; nonce?: string; bootstrapScriptContent?: string; bootstrapScripts?: string[]; bootstrapModules?: string[]; progressiveChunkSize?: number; onShellReady?: () => void; onShellError?: (error: unknown) => void; onAllReady?: () => void; onError?: (error: unknown, errorInfo: ErrorInfo) => string | void; } export interface PipeableStream { abort: (reason?: unknown) => void; pipe: (destination: Writable) => Writable; } export interface ServerOptions { identifierPrefix?: string; } /** * Only available in the environments with [Node.js Streams](https://nodejs.dev/learn/nodejs-streams). * * @see [API](https://reactjs.org/docs/react-dom-server.html#rendertopipeablestream) * * @param children * @param options */ export function renderToPipeableStream(children: ReactNode, options?: RenderToPipeableStreamOptions): PipeableStream; /** * Render a React element to its initial HTML. This should only be used on the server. * React will return an HTML string. You can use this method to generate HTML on the server * and send the markup down on the initial request for faster page loads and to allow search * engines to crawl your pages for SEO purposes. * * If you call `ReactDOMClient.hydrateRoot()` on a node that already has this server-rendered markup, * React will preserve it and only attach event handlers, allowing you * to have a very performant first-load experience. */ export function renderToString(element: ReactNode, options?: ServerOptions): string; /** * Render a React element to its initial HTML. Returns a Readable stream that outputs * an HTML string. The HTML output by this stream is exactly equal to what * `ReactDOMServer.renderToString()` would return. * * @deprecated */ export function renderToNodeStream(element: ReactNode, options?: ServerOptions): NodeJS.ReadableStream; /** * Similar to `renderToString`, except this doesn't create extra DOM attributes * such as `data-reactid`, that React uses internally. This is useful if you want * to use React as a simple static page generator, as stripping away the extra * attributes can save lots of bytes. */ export function renderToStaticMarkup(element: ReactNode, options?: ServerOptions): string; /** * Similar to `renderToNodeStream`, except this doesn't create extra DOM attributes * such as `data-reactid`, that React uses internally. The HTML output by this stream * is exactly equal to what `ReactDOMServer.renderToStaticMarkup()` would return. * * @deprecated */ export function renderToStaticNodeStream(element: ReactNode, options?: ServerOptions): NodeJS.ReadableStream; export interface RenderToReadableStreamOptions { identifierPrefix?: string; namespaceURI?: string; nonce?: string; bootstrapScriptContent?: string; bootstrapScripts?: string[]; bootstrapModules?: string[]; progressiveChunkSize?: number; signal?: AbortSignal; onError?: (error: unknown, errorInfo: ErrorInfo) => string | void; } export interface ReactDOMServerReadableStream extends ReadableStream { allReady: Promise; } /** * Only available in the environments with [Web Streams](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) (this includes browsers, Deno, and some modern edge runtimes). * * @see [API](https://reactjs.org/docs/react-dom-server.html#rendertoreadablestream) */ export function renderToReadableStream( children: ReactNode, options?: RenderToReadableStreamOptions, ): Promise; export const version: string; export as namespace ReactDOMServer;