unstable_matchRSCServerRequest

• Framework
• Data
• Declarative

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

Matches the given routes to a Request and returns a RSC Response encoding an RSCPayload for consumption by a 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,
      }
    );
  },
});

Options

basename

The basename to use when matching the request.

decodeAction

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

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.

decodeFormState

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

generateResponse

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

loadServerAction

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

request

The request to match against.

requestContext

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

routes

Your route definitions.