Skip to content
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

Jump to bottom

Update the docs for Switchable Runtime #36015

Merged
merged 1 commit into from
Apr 8, 2022
Merged

Update the docs for Switchable Runtime #36015

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/advanced-features/react-18/switchable-runtime.md
View file
Open in desktop
@@ -1,6 +1,6 @@
# Switchable Runtime (Alpha)

By default, Next.js uses Node.js as the runtime for page rendering, including pre-rendering, server-side rendering.
By default, Next.js uses Node.js as the runtime for page rendering, including pre-rendering and server-side rendering.

If you have [React 18](/docs/advanced-features/react-18/overview) installed, there is a new experimental feature that lets you switch the page runtime between Node.js and the [Edge Runtime](/docs/api-reference/edge-runtime). Changing the runtime affects [SSR streaming](/docs/advanced-features/react-18/streaming) and [Server Components](/docs/advanced-features/react-18/server-components) features, as well.

Expand All @@ -19,7 +19,7 @@ module.exports = {

This option determines which runtime should be used as the default rendering runtime for all pages.

## Per-page Runtime Option
## Page Runtime Option

On each page, you can optionally export a `runtime` config set to either `'nodejs'` or `'edge'`:

Expand All @@ -32,3 +32,5 @@ export const config = {
When both the per-page runtime and global runtime are set, the per-page runtime overrides the global runtime. If the per-page runtime is _not_ set, the global runtime option will be used.

You can refer to the [Switchable Next.js Runtime RFC](https://github.com/vercel/next.js/discussions/34179) for more information.

**Note:** The page runtime option is not supported in [API Routes](/docs/api-routes/introduction.md) currently.