rsnext/examples/middleware-matcher
Steven Tey 260ea550e0
Added comments to middleware-matcher example (#40273)
## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)


Co-authored-by: Balázs Orbán <18369201+balazsorban44@users.noreply.github.com>
2022-09-13 12:21:05 +00:00
..
pages docs: documents middleware matcher (#40180) 2022-09-05 13:36:09 +00:00
.gitignore docs: documents middleware matcher (#40180) 2022-09-05 13:36:09 +00:00
middleware.js Added comments to middleware-matcher example (#40273) 2022-09-13 12:21:05 +00:00
package.json docs: documents middleware matcher (#40180) 2022-09-05 13:36:09 +00:00
README.md docs: documents middleware matcher (#40180) 2022-09-05 13:36:09 +00:00

Middleware

This example shows how to configure your Next.js Middleware to only match specific pages.

The index page (pages/index.js) has a list of links to dynamic pages, which will tell whether they were matched or not.

The Middleware file (middleware.js) has a special matcher configuration key, allowing you to fine-grained control matched pages.

Please keep in mind that:

  1. Middleware always runs first
  2. Middleware always matches _next routes on server side
  3. matcher must always starts with a '/'

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example middleware-matcher middleware-matcher-app
yarn create next-app --example middleware-matcher middleware-matcher-app
pnpm create next-app --example middleware-matcher middleware-matcher-app

Deploy it to the cloud with Vercel (Documentation).