Skip to content

Commit 9ebd94c

Browse files
committed
docs: update prerenderToNodeStream.md
1 parent d7f4ab7 commit 9ebd94c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/content/reference/react-dom/static/prerenderToNodeStream.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: prerenderToNodeStream
44

55
<Intro>
66

7-
`prerenderToNodeStream` renders a React tree to a static HTML string using a [Node.js Stream.](https://nodejs.org/api/stream.html).
7+
`prerenderToNodeStream` renders a React tree to a static HTML string using a [Node.js Stream](https://nodejs.org/api/stream.html).
88

99
```js
1010
const {prelude} = await prerenderToNodeStream(reactNode, options?)
@@ -63,15 +63,15 @@ On the client, call [`hydrateRoot`](/reference/react-dom/client/hydrateRoot) to
6363
#### Returns {/*returns*/}
6464
6565
`prerenderToNodeStream` returns a Promise:
66-
- If rendering the is successful, the Promise will resolve to an object containing:
66+
- If rendering is successful, the Promise will resolve to an object containing:
6767
- `prelude`: a [Node.js Stream.](https://nodejs.org/api/stream.html) of HTML. You can use this stream to send a response in chunks, or you can read the entire stream into a string.
6868
- If rendering fails, the Promise will be rejected. [Use this to output a fallback shell.](#recovering-from-errors-inside-the-shell)
6969
7070
<Note>
7171
7272
### When should I use `prerenderToNodeStream`? {/*when-to-use-prerender*/}
7373
74-
The static `prerenderToNodeStream` API is used for static server-side generation (SSG). Unlike `renderToString`, `prerenderToNodeStream` waits for all data to load before resolving. This makes it suitable for generating static HTML for a full page, including data that needs to be fetched using Suspense. To stream content as it loads, use a streaming server-side render (SSR) API like [renderToReadableStream](/reference/react-dom/server/renderToReadableStream).
74+
The static `prerenderToNodeStream` API is used for static server-side generation (SSG). Unlike `renderToString`, `prerenderToNodeStream` waits for all data to load before resolving. This makes it suitable for generating static HTML for a full page, including data that needs to be fetched using Suspense. To stream content as it loads, use a streaming server-side render (SSR) API like [`renderToReadableStream`](/reference/react-dom/server/renderToReadableStream).
7575
7676
</Note>
7777
@@ -81,7 +81,7 @@ The static `prerenderToNodeStream` API is used for static server-side generation
8181
8282
### Rendering a React tree to a stream of static HTML {/*rendering-a-react-tree-to-a-stream-of-static-html*/}
8383
84-
Call `prerenderToNodeStream` to render your React tree to static HTML into a [Node.js Stream.](https://nodejs.org/api/stream.html):
84+
Call `prerenderToNodeStream` to render your React tree to static HTML into a [Node.js Stream](https://nodejs.org/api/stream.html):
8585
8686
```js [[1, 5, "<App />"], [2, 6, "['/main.js']"]]
8787
import { prerenderToNodeStream } from 'react-dom/static';
@@ -91,7 +91,7 @@ app.use('/', async (request, response) => {
9191
const { prelude } = await prerenderToNodeStream(<App />, {
9292
bootstrapScripts: ['/main.js'],
9393
});
94-
94+
9595
response.setHeader('Content-Type', 'text/plain');
9696
prelude.pipe(response);
9797
});
@@ -228,7 +228,7 @@ async function renderToString() {
228228
const {prelude} = await prerenderToNodeStream(<App />, {
229229
bootstrapScripts: ['/main.js']
230230
});
231-
231+
232232
return new Promise((resolve, reject) => {
233233
let data = '';
234234
prelude.on('data', chunk => {
@@ -291,5 +291,5 @@ Suspense-enabled data fetching without the use of an opinionated framework is no
291291
292292
The `prerenderToNodeStream` response waits for the entire app to finish rendering, including waiting for all suspense boundaries to resolve, before resolving. It is designed for static site generation (SSG) ahead of time and does not support streaming more content as it loads.
293293
294-
To stream content as it loads, use a streaming server render API like [renderToPipeableStream](/reference/react-dom/server/renderToPipeableStream).
295-
294+
To stream content as it loads, use a streaming server render API like [`renderToPipeableStream`](/reference/react-dom/server/renderToPipeableStream).
295+

0 commit comments

Comments
 (0)