Skip to content

docs: document RenderOptions.waitUntil #13744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gllmt wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: document RenderOptions.waitUntil #13744

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61a6c7a
docs: add RenderOptions.waitUntil reference
gllmt Apr 16, 2026
50b471b
docs: address waitUntil review feedback
gllmt Apr 16, 2026
735e48f
Merge branch 'main' into docs/renderoptions-waituntil
gllmt Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion src/content/docs/en/reference/modules/astro-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ import type {

<p>

**Type:** `{addCookieHeader?: boolean; clientAddress?: string; locals?: object; prerenderedErrorPageFetch?: (url: ErrorPagePath) => Promise<Response>; routeData?: RouteData;}`
**Type:** `{addCookieHeader?: boolean; clientAddress?: string; locals?: object; prerenderedErrorPageFetch?: (url: ErrorPagePath) => Promise<Response>; waitUntil?: (promise: Promise<unknown>) => void; routeData?: RouteData;}`
</p>

Describes the options for controlling the routes rendering.
Expand Down Expand Up @@ -346,6 +346,28 @@ return app.render(request, {

If not provided, Astro will fallback to its default behavior for fetching error pages.

#### `RenderOptions.waitUntil`
Comment thread
ArmandPhilippot marked this conversation as resolved.
Outdated

<p>

**Type:** `(promise: Promise<unknown>) => void`<br />
<Since v="6.2.0" />
</p>

An optional runtime hook for background work after the response is sent.

Adapters can pass this through to let runtime cache providers schedule work such as cache writes or stale-while-revalidate without blocking the response path.

The following example forwards a runtime's `waitUntil` implementation to [`app.render()`](#apprender):
Comment thread
ArmandPhilippot marked this conversation as resolved.
Outdated

```js "waitUntil"
return app.render(request, {
routeData,
locals,
waitUntil,
});
```
Comment thread
ArmandPhilippot marked this conversation as resolved.
Outdated

#### `RenderOptions.routeData`

<p>
Expand Down
Loading