From 2a229aaad40f03d2d713ad97db09d71c761e936d Mon Sep 17 00:00:00 2001 From: pawannyadav05 Date: Sat, 21 Nov 2026 00:54:08 +0530 Subject: [PATCH] docs: clarify that resumeAndPrerender prelude stream is partial when postponed Clarifies in the resumeAndPrerender reference documentation that the returned prelude stream is not necessarily a standalone, complete HTML document if rendering was postponed or aborted, preventing confusion where developers attempt to send the prelude directly as the entire HTTP response body. Fixes #8755 --- src/content/reference/react-dom/static/resumeAndPrerender.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/reference/react-dom/static/resumeAndPrerender.md b/src/content/reference/react-dom/static/resumeAndPrerender.md index 2a9917d43da..71e72b8715e 100644 --- a/src/content/reference/react-dom/static/resumeAndPrerender.md +++ b/src/content/reference/react-dom/static/resumeAndPrerender.md @@ -60,7 +60,7 @@ On the client, call [`hydrateRoot`](/reference/react-dom/client/hydrateRoot) to `prerender` returns a Promise: - If rendering the is successful, the Promise will resolve to an object containing: - - `prelude`: a [Web Stream](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) of HTML. You can use this stream to send a response in chunks, or you can read the entire stream into a string. + - `prelude`: a [Web Stream](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) of HTML containing the rendered shell and resolved segments. Note that this stream is not necessarily a complete HTML document if rendering was postponed or aborted. To deliver a complete response to a browser, combine the static prelude with the resumed stream or ensure `` renders root `` and `` tags without unhandled postponed boundaries. - `postponed`: an JSON-serializeable, opaque object that can be passed to [`resume`](/reference/react-dom/server/resume) or [`resumeAndPrerender`](/reference/react-dom/static/resumeAndPrerender) if `prerender` is aborted. - If rendering fails, the Promise will be rejected. [Use this to output a fallback shell.](/reference/react-dom/server/renderToReadableStream#recovering-from-errors-inside-the-shell)