Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

flight.ts

68 lines2.0 KB

1/**
2 * Low-level Flight stream APIs for decoding RSC streams.
3 *
4 * These functions provide direct access to RSC Flight stream decoding,
5 * allowing advanced use cases like:
6 * - Server functions returning raw Flight Response
7 * - API routes streaming Flight payloads
8 * - Custom Flight stream handling via RawStream
9 *
10 * `createFromReadableStream` works in both SSR and browser contexts.
11 * `createFromFetch` is browser-only.
12 *
13 * NOTE: Dynamic imports keep decode initialisation runtime-specific. The
14 * concrete implementation comes from bundler-owned virtual modules.
15 */
16​
17import {
18 createClientOnlyFn,
19 createIsomorphicFn,
20} from '@tanstack/start-fn-stubs'
21​
22/**
23 * Decode a Flight stream into React elements.
24 * Works in both SSR and browser contexts.
25 *
26 * @example
27 * ```tsx
28 * const rawStream = await getRscRawStream()
29 * const tree = await createFromReadableStream(rawStream)
30 * return <>{tree}</>
31 * ```
32 */
33export const createFromReadableStream = createIsomorphicFn()
34 .server(
35 async (stream: ReadableStream<Uint8Array>): Promise<React.ReactNode> => {
36 const { createFromReadableStream: decode } =
37 await import('virtual:tanstack-rsc-ssr-decode')
38 return decode(stream) as React.ReactNode
39 },
40 )
41 .client(
42 async (stream: ReadableStream<Uint8Array>): Promise<React.ReactNode> => {
43 const { createFromReadableStream: decode } =
44 await import('virtual:tanstack-rsc-browser-decode')
45 return decode(stream)
46 },
47 )
48​
49/**
50 * Decode a Flight stream from a fetch Response.
51 * Browser only - will throw if called on the server.
52 *
53 * @example
54 * ```tsx
55 * // From server function returning raw Response
56 * const tree = await createFromFetch(getFlightResponse())
57 *
58 * // From API route
59 * const tree = await createFromFetch(fetch('/api/rsc-flight'))
60 * ```
61 */
62export const createFromFetch = createClientOnlyFn(
63 async (fetchPromise: Promise<Response>): Promise<React.ReactNode> => {
64 const { createFromFetch: decode } =
65 await import('virtual:tanstack-rsc-browser-decode')
66 return decode(fetchPromise)
67 },