Skip to content

Commit 12320a7

Browse files
committed
update
1 parent cb94434 commit 12320a7

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

src/routes/reference/rendering/render-to-string-async.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Function that returns the root output to render.
5050

5151
- **Type:** `number`
5252

53-
Maximum wait time for suspense boundaries before the render resolves.
53+
Maximum wait time before the returned promise rejects.
5454

5555
#### `nonce`
5656

@@ -68,7 +68,7 @@ Identifier used to namespace the render output.
6868

6969
- **Type:** `boolean`
7070

71-
Disables script emission in the rendered output.
71+
Disables script emission, including serialized data used for hydration continuation.
7272

7373
#### `onError`
7474

@@ -84,7 +84,8 @@ Promise that resolves to the rendered HTML string.
8484

8585
## Behavior
8686

87-
- `renderToStringAsync` waits for server suspense boundaries to settle before resolving.
87+
- `renderToStringAsync` is a server rendering API and is unsupported in browser bundles. It builds on [`renderToStream`](/reference/rendering/render-to-stream) and waits for the full stream result before resolving.
88+
- If the timeout elapses, the returned promise rejects instead of resolving partial HTML.
8889
- Resource data is serialized for client hydration unless scripts are disabled.
8990
- `renderId` namespaces the render output when multiple top-level roots are present.
9091

0 commit comments

Comments
 (0)