Skip to content

Commit d055fee

Browse files
chozzzvadi-toptal
andauthoredJan 26, 2022
Updated docs for getServerSideProps and getStaticProps return values (#33577)
This fixes the documentation for getServerSideProps and getStaticProps which mislead the defined type. Current screenshot taken from [nextjs doc](https://nextjs.org/docs/api-reference/data-fetching/get-server-side-props) ![image](https://user-images.githubusercontent.com/5223310/150689799-5da3c1b6-61ae-4455-8970-8c96f025474a.png) However, the declared type for these types are using union type which represents **any of the following** instead of **optional**. Declared types; [GetStaticPropsResult](https://github.com/vercel/next.js/blob/canary/packages/next/types/index.d.ts#L107) ![image](https://user-images.githubusercontent.com/5223310/150689919-5f3cf8f8-60d3-48e4-9412-993e2ead0634.png) [GetServerSidePropsResult](https://github.com/vercel/next.js/blob/canary/packages/next/types/index.d.ts#L160) ![image](https://user-images.githubusercontent.com/5223310/150689931-16fe3bef-eb4e-41cd-b087-98c3282d599d.png) --- ### This PR updates the documentation for their return values; **Before**: The `...` function should return an object with the following **optional** properties: **After**: The `...` function should return object with **any one of the following** properties: --- ## Bug - [x] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [x] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [x] Make sure the linting passes by running `yarn lint` Co-authored-by: Vadi Taslim <70912283+vaditaslim@users.noreply.github.com>
1 parent 8d1c585 commit d055fee

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed
 

‎docs/api-reference/data-fetching/get-server-side-props.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The `context` parameter is an object containing the following keys:
4343

4444
## getServerSideProps return values
4545

46-
The `getServerSideProps` function should return an object with the following **optional** properties:
46+
The `getServerSideProps` function should return an object with **any one of the following** properties:
4747

4848
### `props`
4949

‎docs/api-reference/data-fetching/get-static-props.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The `context` parameter is an object containing the following keys:
4141

4242
## getStaticProps return values
4343

44-
The `getStaticProps` function should return an object with the following **optional** properties:
44+
The `getStaticProps` function should return an object containing either `props`, `redirect`, or `notFound` followed by an **optional** `revalidate` property.
4545

4646
### `props`
4747

0 commit comments

Comments
 (0)
Please sign in to comment.