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

Added "negative matcher" documentation #40282

Merged
merged 4 commits into from Sep 13, 2022
Merged

Added "negative matcher" documentation #40282

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
710da43
Added "negative matcher" documentation
steven-tey Sep 6, 2022
ec3ccee
Update middleware.md
steven-tey Sep 6, 2022
15613dc
mention other regex matching as well
ijjk Sep 13, 2022
b1b98fa
Merge branch 'canary' into steven-tey-patch-2
ijjk Sep 13, 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
16 changes: 16 additions & 0 deletions docs/advanced-features/middleware.md
View file
Open in desktop
Expand Up @@ -88,6 +88,22 @@ export const config = {
}
```

You can also create a "negative matcher" that matches all paths except for certain paths:
Copy link
Member

Choose a reason for hiding this comment

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

Should we expand this to say full regex matching can be used including negative lookaheads like this


```js
export const config = {
matcher: [
/*
* Match all request paths except for the ones starting with:
* - api (API routes)
* - static (static files)
* - favicon.ico (favicon file)
*/
"/((?!api|static|favicon.ico).*)",
],
}
```

> **Note:** The `matcher` values need to be constants so they can be statically analyzed at build-time. Dynamic values such as variables will be ignored.

Configured matchers:
Expand Down