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

change anonymous functions to named in docs examples #17510

Merged
merged 3 commits into from
Oct 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/advanced-features/preview-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ First, create a **preview API route**. It can have any name - e.g. `pages/api/pr
In this API route, you need to call `setPreviewData` on the response object. The argument for `setPreviewData` should be an object, and this can be used by `getStaticProps` (more on this later). For now, we’ll use `{}`.

```js
export default (req, res) => {
export default function handler(req, res) {
// ...
res.setPreviewData({})
// ...
Expand All @@ -54,7 +54,7 @@ You can test this manually by creating an API route like below and accessing it
// A simple example for testing it manually from your browser.
// If this is located at pages/api/preview.js, then
// open /api/preview from your browser.
export default (req, res) => {
export default function handler(req, res) {
res.setPreviewData({})
res.end('Preview mode enabled')
}
Expand Down Expand Up @@ -175,7 +175,7 @@ By default, no expiration date is set for the preview mode cookies, so the previ
To clear the preview cookies manually, you can create an API route which calls `clearPreviewData` and then access this API route.

```js
export default (req, res) => {
export default function handler(req, res) {
// Clears the preview mode cookies.
// This function accepts no arguments.
res.clearPreviewData()
Expand Down
4 changes: 2 additions & 2 deletions docs/api-routes/dynamic-api-routes.md
Original file line number Diff line number Diff line change
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 handler(req, res) {
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 handler(req, res) {
const {
query: { slug },
} = req
Expand Down
4 changes: 2 additions & 2 deletions docs/api-routes/introduction.md
Original file line number Diff line number Diff line change
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 handler(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 handler(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
Original file line number Diff line number Diff line change
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 handler(req, res) {
res.status(200).json({ name: 'Next.js' })
}
```
Expand Down