Skip to content

docs: clarify route-scoped middleware example path #4445

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

Open
BTF-Kabir-2020 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

docs: clarify route-scoped middleware example path #4445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions docs/1.docs/5.routing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ export default defineConfig({
handlers: [
{
route: "/api/**",
handler: "./server/middleware/api-auth.ts",
handler: "./server/utils/api-auth.ts",
middleware: true,
},
],
Expand All @@ -298,7 +298,7 @@ Nitro route middleware can hook into the request lifecycle.
A middleware can modify the request before it is processed, not after.
::

Middleware are auto-registered within the `middleware/` directory.
When [`serverDir`](/config#serverdir) is set, middleware are auto-registered from the `middleware/` directory.

```md
middleware/
Expand All @@ -323,7 +323,7 @@ export default defineHandler((event) => {
});
```

Middleware in `middleware/` directory are automatically registered for all routes. If you want to register a middleware for a specific route, see [Object Syntax Event Handler](https://h3.dev/guide/basics/handler#object-syntax).
With [`serverDir`](/config#serverdir) enabled, files in the `middleware/` directory are automatically registered for all routes. If you want to register a middleware for a specific route, see [Object Syntax Event Handler](https://h3.dev/guide/basics/handler#object-syntax) or [route-scoped middleware](#route-scoped-middleware).

::note
Returning anything from a middleware will close the request and should be avoided! Any returned value from middleware will be the response and further code will not be executed however **this is not recommended to do!**
Expand Down Expand Up @@ -408,14 +408,16 @@ export default defineConfig({
handlers: [
{
route: "/api/**",
handler: "./server/middleware/api-auth.ts",
handler: "./server/utils/api-auth.ts",
middleware: true,
},
],
});
```

Unlike global middleware (registered in the `middleware/` directory which match `/**`), route-scoped middleware only run for requests matching the specified pattern.
Unlike global middleware (auto-registered from the `middleware/` directory when [`serverDir`](/config#serverdir) is set, matching `/**`), route-scoped middleware only run for requests matching the specified pattern.

Prefer placing route-scoped handler files outside `middleware/` (as in the example above) so directory scanning does not also register them globally when `serverDir` is enabled.

## Error handling

Expand Down
Loading