Update getServerSideProps docs with req.cookie note #29457
Conversation
a73295b to
6214bfa
Compare
docs/basic-features/data-fetching.md
Outdated
| ### Built-in `context.req` parsing | ||
|
|
||
| To improve the developer experience, the `context.req` request object received by `getServerSideProps` is pre-parsed to include some additional helpful properties. Those properties are: | ||
|
|
||
| - `context.req.cookies` - An object containing the cookies sent by the request. Defaults to `{}` |
There was a problem hiding this comment.
Hmm, I was thinking there were more helpers than just cookies but then I checked the type and its just cookies like you mentioned
next.js/packages/next/types/index.d.ts
Lines 148 to 151 in c27e3a4
And it looks like res doesn't have any helpers so maybe its best to go back to your original commit where it was mentioned inline.
There was a problem hiding this comment.
Or maybe we discovered a strange behavior where getServerSideProps() differs to much from API Routes and we should try to use the same helpers for both 🤔
There was a problem hiding this comment.
Personally, I don't think it hurts to have this extra section, even if it just talks about 1 helper. Nice for google foo
There was a problem hiding this comment.
I agree with @molebox, I like that we'd be able to deeplink to this section. Additionally, this makes it easier to expand the list in the future if we do want to get to parity with the API route helpers
docs/basic-features/data-fetching.md
Outdated
| ### Built-in `context.req` parsing | ||
|
|
||
| To improve the developer experience, the `context.req` request object received by `getServerSideProps` is pre-parsed to include some additional helpful properties. Those properties are: | ||
|
|
||
| - `context.req.cookies` - An object containing the cookies sent by the request. Defaults to `{}` |
There was a problem hiding this comment.
Personally, I don't think it hurts to have this extra section, even if it just talks about 1 helper. Nice for google foo
Co-authored-by: Rich Haines <hello@richardhaines.dev>
|
@molebox do you have the super powers necessary to approve running the workflows? |
|
@Vitorba |
Tweak the wording of the new getServerSideProps middleware section so it matches closer to the one in https://nextjs.org/docs/api-routes/api-middlewares. Co-authored-by: JJ Kasper <jj@jjsweb.site>
|
@ijjk thanks, good tweaks! Added 😃 |
Documentation / Examples
Add a note to the
getServerSidePropsdocs thatcontext.reqcontains acontext.req.cookiesattribute.I based the copy off of the one from https://nextjs.org/docs/api-routes/api-middlewares.
Checklist: