Skip to content

Commit

Permalink
Clarify headers config option description
Browse files Browse the repository at this point in the history
Reading over this page, it wasn't immediately clear to me if these were headers which would get read off of the incoming request, or headers to be added to the outgoing response.
  • Loading branch information
lobsterkatie authored Jan 14, 2022
1 parent 7db6aa2 commit 3e862c5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api-reference/next.config.js/headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: Add custom HTTP headers to your Next.js app.

</details>

Headers allow you to set custom HTTP headers for an incoming request path.
Headers allow you to set custom HTTP headers on the response to an incoming request on a given path.

To set custom HTTP headers you can use the `headers` key in `next.config.js`:

Expand Down Expand Up @@ -50,7 +50,7 @@ module.exports = {
`headers` is an async function that expects an array to be returned holding objects with `source` and `headers` properties:

- `source` is the incoming request path pattern.
- `headers` is an array of header objects with the `key` and `value` properties.
- `headers` is an array of headers to add to the response - each header is an object with `key` and `value` properties.
- `basePath`: `false` or `undefined` - if false the basePath won't be included when matching, can be used for external rewrites only.
- `locale`: `false` or `undefined` - whether the locale should not be included when matching.
- `has` is an array of [has objects](#header-cookie-and-query-matching) with the `type`, `key` and `value` properties.
Expand Down

0 comments on commit 3e862c5

Please sign in to comment.