(docs) Add format to notFound
for consistency (#18363)
The previous props are in bold, but `notFound` is not.
This commit is contained in:
parent
f8f0c6bb91
commit
907888c70a
1 changed files with 4 additions and 4 deletions
|
@ -62,8 +62,8 @@ The `context` parameter is an object containing the following keys:
|
||||||
|
|
||||||
- `props` - A **required** object with the props that will be received by the page component. It should be a [serializable object](https://en.wikipedia.org/wiki/Serialization)
|
- `props` - A **required** object with the props that will be received by the page component. It should be a [serializable object](https://en.wikipedia.org/wiki/Serialization)
|
||||||
- `revalidate` - An **optional** amount in seconds after which a page re-generation can occur. More on [Incremental Static Regeneration](#incremental-static-regeneration)
|
- `revalidate` - An **optional** amount in seconds after which a page re-generation can occur. More on [Incremental Static Regeneration](#incremental-static-regeneration)
|
||||||
- `notFound` - An optional boolean value to allow the page to return a 404 status and page. More on [Incremental Static Regeneration](#incremental-static-regeneration)
|
- `notFound` - An **optional** boolean value to allow the page to return a 404 status and page. More on [Incremental Static Regeneration](#incremental-static-regeneration)
|
||||||
- `redirect` - An optional redirect value to allow redirecting to internal and external resources. It should match the shape of `{ destination: string, permanent: boolean }`. In some rare cases, you might need to assign a custom status code for older HTTP Clients to properly redirect. In these cases, you can use the `statusCode` property instead of the `permanent` property, but not both.
|
- `redirect` - An **optional** redirect value to allow redirecting to internal and external resources. It should match the shape of `{ destination: string, permanent: boolean }`. In some rare cases, you might need to assign a custom status code for older HTTP Clients to properly redirect. In these cases, you can use the `statusCode` property instead of the `permanent` property, but not both.
|
||||||
|
|
||||||
> **Note**: You can import modules in top-level scope for use in `getStaticProps`.
|
> **Note**: You can import modules in top-level scope for use in `getStaticProps`.
|
||||||
> Imports used in `getStaticProps` will [not be bundled for the client-side](#write-server-side-code-directly).
|
> Imports used in `getStaticProps` will [not be bundled for the client-side](#write-server-side-code-directly).
|
||||||
|
@ -556,8 +556,8 @@ The `context` parameter is an object containing the following keys:
|
||||||
`getServerSideProps` should return an object with:
|
`getServerSideProps` should return an object with:
|
||||||
|
|
||||||
- `props` - A **required** object with the props that will be received by the page component. It should be a [serializable object](https://en.wikipedia.org/wiki/Serialization)
|
- `props` - A **required** object with the props that will be received by the page component. It should be a [serializable object](https://en.wikipedia.org/wiki/Serialization)
|
||||||
- `notFound` - An optional boolean value to allow the page to return a 404 status and page. More on [Incremental Static Regeneration](#incremental-static-regeneration)
|
- `notFound` - An **optional** boolean value to allow the page to return a 404 status and page. More on [Incremental Static Regeneration](#incremental-static-regeneration)
|
||||||
- `redirect` - An optional redirect value to allow redirecting to internal and external resources. It should match the shape of `{ destination: string, permanent: boolean }`. In some rare cases, you might need to assign a custom status code for older HTTP Clients to properly redirect. In these cases, you can use the `statusCode` property instead of the `permanent` property, but not both.
|
- `redirect` - An **optional** redirect value to allow redirecting to internal and external resources. It should match the shape of `{ destination: string, permanent: boolean }`. In some rare cases, you might need to assign a custom status code for older HTTP Clients to properly redirect. In these cases, you can use the `statusCode` property instead of the `permanent` property, but not both.
|
||||||
|
|
||||||
> **Note**: You can import modules in top-level scope for use in `getServerSideProps`.
|
> **Note**: You can import modules in top-level scope for use in `getServerSideProps`.
|
||||||
> Imports used in `getServerSideProps` will not be bundled for the client-side.
|
> Imports used in `getServerSideProps` will not be bundled for the client-side.
|
||||||
|
|
Loading…
Reference in a new issue