UNPKG

1.37 kBTypeScriptView Raw
1
2//#region lib/rsc/html-stream/browser.d.ts
3declare global {
4 interface Window {
5 __FLIGHT_DATA: any[];
6 }
7}
8/**
9 * Get the prerendered [RSC](https://react.dev/reference/rsc/server-components)
10 * stream for hydration. Usually passed directly to your
11 * `react-server-dom-xyz/client`'s `createFromReadableStream`.
12 *
13 * @example
14 * import { startTransition, StrictMode } from "react";
15 * import { hydrateRoot } from "react-dom/client";
16 * import {
17 * unstable_getRSCStream as getRSCStream,
18 * unstable_RSCHydratedRouter as RSCHydratedRouter,
19 * } from "react-router";
20 * import type { unstable_RSCPayload as RSCPayload } from "react-router";
21 *
22 * createFromReadableStream(getRSCStream()).then(
23 * (payload: RSCServerPayload) => {
24 * startTransition(async () => {
25 * hydrateRoot(
26 * document,
27 * <StrictMode>
28 * <RSCHydratedRouter {...props} />
29 * </StrictMode>,
30 * {
31 * // Options
32 * }
33 * );
34 * });
35 * }
36 * );
37 *
38 * @name unstable_getRSCStream
39 * @public
40 * @category RSC
41 * @mode data
42 * @returns A [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
43 * that contains the [RSC](https://react.dev/reference/rsc/server-components)
44 * data for hydration.
45 */
46declare function getRSCStream(): ReadableStream;
47//#endregion
48export { getRSCStream };
\No newline at end of file