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.

Sign up for GitHub

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

Jump to bottom

docs: clarify redirects on client-side navigation #41362

Merged
merged 7 commits into from Oct 12, 2022
Merged

docs: clarify redirects on client-side navigation #41362

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fd99b05
docs: clarify `redirects` and `rewrites` on client-side navigation
balazsorban44 Oct 12, 2022
f9c1690
add note about Middleware
balazsorban44 Oct 12, 2022
97579db
mention `Link`, `router.push`
balazsorban44 Oct 12, 2022
866f87a
Update rewrites.md
balazsorban44 Oct 12, 2022
6b73746
Merge branch 'canary' into docs/issue-41344
balazsorban44 Oct 12, 2022
fb80852
Update docs/api-reference/next.config.js/redirects.md
balazsorban44 Oct 12, 2022
7fc7d5a
Update docs/api-reference/next.config.js/redirects.md
balazsorban44 Oct 12, 2022
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: 3 additions & 1 deletion docs/api-reference/next.config.js/redirects.md
View file
Open in desktop
Expand Up @@ -47,12 +47,14 @@ module.exports = {

> **Why does Next.js use 307 and 308?** Traditionally a 302 was used for a temporary redirect, and a 301 for a permanent redirect, but many browsers changed the request method of the redirect to `GET`, regardless of the original method. For example, if the browser made a request to `POST /v1/users` which returned status code `302` with location `/v2/users`, the subsequent request might be `GET /v2/users` instead of the expected `POST /v2/users`. Next.js uses the 307 temporary redirect, and 308 permanent redirect status codes to explicitly preserve the request method used.

- `basePath`: `false` or `undefined` - if false the basePath won't be included when matching, can be used for external rewrites only.
- `basePath`: `false` or `undefined` - if false the `basePath` won't be included when matching, can be used for external redirects 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.

Redirects are checked before the filesystem which includes pages and `/public` files.

Redirects are not applied to client-side routing (`Link`, `router.push`), unless [Middleware](/docs/advanced-features/middleware) is present and matches the path.

When a redirect is applied, any query values provided in the request will be passed through to the redirect destination. For example, see the following redirect configuration:

```js
Expand Down