unstable_matchRSCServerRequest

[MODES: data]

<docs-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.</docs-warning>

Summary

Reference Documentation ↗

Matches the given routes to a Request and returns an RSC Response encoding an unstable_RSCPayload for consumption by an RSC enabled client router.

import {
  createTemporaryReferenceSet,
  decodeAction,
  decodeReply,
  loadServerAction,
  renderToReadableStream,
} from "@vitejs/plugin-rsc/rsc";
import { unstable_matchRSCServerRequest as matchRSCServerRequest } from "react-router";

matchRSCServerRequest({
  createTemporaryReferenceSet,
  decodeAction,
  decodeFormState,
  decodeReply,
  loadServerAction,
  request,
  routes: routes(),
  generateResponse(match) {
    return new Response(
      renderToReadableStream(match.payload),
      {
        status: match.statusCode,
        headers: match.headers,
      }
    );
  },
});

Signature

async function matchRSCServerRequest({
  allowedActionOrigins,
  createTemporaryReferenceSet,
  basename,
  decodeReply,
  requestContext,
  loadServerAction,
  decodeAction,
  decodeFormState,
  onError,
  request,
  routes,
  generateResponse,
}: {
  allowedActionOrigins?: string[];
  createTemporaryReferenceSet: () => unknown;
  basename?: string;
  decodeReply?: DecodeReplyFunction;
  decodeAction?: DecodeActionFunction;
  decodeFormState?: DecodeFormStateFunction;
  requestContext?: RouterContextProvider;
  loadServerAction?: LoadServerActionFunction;
  onError?: (error: unknown) => void;
  request: Request;
  routes: RSCRouteConfigEntry[];
  generateResponse: (
    match: RSCMatch,
    {
      onError,
      temporaryReferences,
    }: {
      onError(error: unknown): string | undefined;
      temporaryReferences: unknown;
    },
  ) => Response;
}): Promise<Response>

Params

opts.allowedActionOrigins

Origin patterns that are allowed to execute actions.

opts.basename

The basename to use when matching the request.

opts.createTemporaryReferenceSet

A function that returns a temporary reference set for the request, used to track temporary references in the RSC stream.

opts.decodeAction

Your react-server-dom-xyz/server's decodeAction function, responsible for loading a server action.

opts.decodeFormState

A function responsible for decoding form state for progressively enhanceable forms with React's useActionState using your react-server-dom-xyz/server's decodeFormState.

opts.decodeReply

Your react-server-dom-xyz/server's decodeReply function, used to decode the server function's arguments and bind them to the implementation for invocation by the router.

opts.generateResponse

A function responsible for using your renderToReadableStream to generate a Response encoding the unstable_RSCPayload.

opts.loadServerAction

Your react-server-dom-xyz/server's loadServerAction function, used to load a server action by ID.

opts.onError

An optional error handler that will be called with any errors that occur during the request processing.

opts.request

The Request to match against.

opts.requestContext

An instance of RouterContextProvider that should be created per request, to be passed to actions, loaders and middleware.

opts.routes

Your route definitions.

Returns

A Response that contains the RSC data for hydration.