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.

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

Gave names to anonymous functions in the docs. Tried to be as semantic as possible. #17549

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
4 changes: 2 additions & 2 deletions docs/api-routes/dynamic-api-routes.md
Expand Up @@ -16,7 +16,7 @@ API routes support [dynamic routes](/docs/routing/dynamic-routes.md), and follow
For example, the API route `pages/api/post/[pid].js` has the following code:

```js
export default (req, res) => {
export default function PostId(req, res){
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's either use handler for all the names, or something that focuses on what the function returns, e.g getPost (and doesn't start with an uppercase)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I'll go ahead and fix that. Thanks!

const {
query: { pid },
} = req
Expand Down Expand Up @@ -68,7 +68,7 @@ And in the case of `/api/post/a/b`, and any other matching path, new parameters
An API route for `pages/api/post/[...slug].js` could look like this:

```js
export default (req, res) => {
export default function CatchSlug(req, res){
const {
query: { slug },
} = req
Expand Down
4 changes: 2 additions & 2 deletions docs/api-routes/introduction.md
Expand Up @@ -22,7 +22,7 @@ Any file inside the folder `pages/api` is mapped to `/api/*` and will be treated
For example, the following API route `pages/api/user.js` handles a `json` response:

```js
export default (req, res) => {
export default function UserName(req, res){
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify({ name: 'John Doe' }))
Expand All @@ -37,7 +37,7 @@ For an API route to work, you need to export as default a function (a.k.a **requ
To handle different HTTP methods in an API route, you can use `req.method` in your request handler, like so:

```js
export default (req, res) => {
export default function PostReq(req, res){
if (req.method === 'POST') {
// Process a POST request
} else {
Expand Down
2 changes: 1 addition & 1 deletion docs/api-routes/response-helpers.md
Expand Up @@ -15,7 +15,7 @@ description: API Routes include a set of Express.js-like methods for the respons
The response (`res`) includes a set of Express.js-like methods to improve the developer experience and increase the speed of creating new API endpoints, take a look at the following example:

```js
export default (req, res) => {
export default function ResHelper(req, res){
res.status(200).json({ name: 'Next.js' })
}
```
Expand Down