forked from vercel/next.js
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs related to React 18 (vercel#35952)
* update docs of streaming * add switchable runtime docs * add page to manifest * Apply suggestions from code review Co-authored-by: Steven <steven@ceriously.com> * Update docs/advanced-features/react-18/streaming.md Co-authored-by: Lee Robinson <me@leerob.io> Co-authored-by: Steven <steven@ceriously.com>
- Loading branch information
1 parent
c34bdb1
commit 02a81a2
Showing
4 changed files
with
55 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Switchable Runtime (Alpha) | ||
|
||
By default, Next.js uses Node.js as the runtime for page rendering, including pre-rendering, 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. | ||
|
||
## Global Runtime Option | ||
|
||
You can set the experimental option `runtime` to either `'nodejs'` or `'edge'` in your `next.config.js` file: | ||
|
||
```jsx | ||
// next.config.js | ||
module.exports = { | ||
experimental: { | ||
runtime: 'nodejs', | ||
}, | ||
} | ||
``` | ||
|
||
This option determines which runtime should be used as the default rendering runtime for all pages. | ||
|
||
## Per-page Runtime Option | ||
|
||
On each page, you can optionally export a `runtime` config set to either `'nodejs'` or `'edge'`: | ||
|
||
```jsx | ||
export const config = { | ||
runtime: 'nodejs', | ||
} | ||
``` | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters