unstable_routeRSCServerRequest

Data

Warning

This API is experimental and subject to breaking changes in minor/patch releases. Please use with caution and pay very close attention to release notes for relevant changes.

Summary

Reference Documentation ↗

Routes the incoming Request to the RSC server and appropriately proxies the server response for data / resource requests, or renders to HTML for a document request.

import { createFromReadableStream } from "@vitejs/plugin-rsc/ssr";
import * as ReactDomServer from "react-dom/server.edge";
import {
  unstable_RSCStaticRouter as RSCStaticRouter,
  unstable_routeRSCServerRequest as routeRSCServerRequest,
} from "react-router";

routeRSCServerRequest({
  request,
  serverResponse,
  createFromReadableStream,
  nonce,
  async renderHTML(getPayload, options) {
    const payload = getPayload();

    return await renderHTMLToReadableStream(
      <RSCStaticRouter
        getPayload={getPayload}
        nonce={options.nonce}
      />,
      {
        ...options,
        bootstrapScriptContent,
        formState: await payload.formState,
      }
    );
  },
});

Signature

async function routeRSCServerRequest({
  request,
  serverResponse,
  createFromReadableStream,
  renderHTML,
  hydrate = true,
  nonce,
}: {
  request: Request;
  serverResponse: Response;
  createFromReadableStream: SSRCreateFromReadableStreamFunction;
  renderHTML: (
    getPayload: () => DecodedPayload,
    options: {
      nonce?: string;
      onError(error: unknown): string | undefined;
      onHeaders(headers: Headers): void;
    },
  ) => ReadableStream<Uint8Array> | Promise<ReadableStream<Uint8Array>>;
  hydrate?: boolean;
  nonce?: string;
}): Promise<Response>

Params

opts.createFromReadableStream

Your react-server-dom-xyz/client's createFromReadableStream function, used to decode payloads from the server.

opts.serverResponse

A Response or partial response generated by the RSC handler containing a serialized unstable_RSCPayload.

opts.hydrate

Whether to hydrate the server response with the RSC payload. Defaults to true.

opts.nonce

An optional nonce for inline scripts generated while rendering the HTML document.

opts.renderHTML

A function that renders the unstable_RSCPayload to HTML, usually using a <RSCStaticRouter>.

opts.request

The request to route.

Returns

A Response that either contains the RSC payload for data requests, or renders the HTML for document requests.