mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-23 14:15:13 +00:00
60 lines
1.9 KiB
Markdown
60 lines
1.9 KiB
Markdown
# `defineNuxtRouteMiddleware`
|
||
|
||
You can create named route middleware using `defineNuxtRouteMiddleware` helper function.
|
||
|
||
Route middleware are stored in the `middleware/` directory of your Nuxt application (unless [set otherwise](/api/configuration/nuxt.config#middleware)).
|
||
|
||
## Type
|
||
|
||
```ts
|
||
defineNuxtRouteMiddleware(middleware: RouteMiddleware) => RouteMiddleware
|
||
|
||
interface RouteMiddleware {
|
||
(to: RouteLocationNormalized, from: RouteLocationNormalized): ReturnType<NavigationGuard>
|
||
}
|
||
```
|
||
|
||
## Parameters
|
||
|
||
### `middleware`
|
||
|
||
- **Type**: `RouteMiddleware`
|
||
|
||
A function that takes two Vue Router's route location objects as parameters: the next route `to` as the first, and the current route `from` as the second.
|
||
|
||
Learn more about available properties of `RouteLocationNormalized` in the **[Vue Router docs](https://router.vuejs.org/api/interfaces/RouteLocationNormalized.html)**.
|
||
|
||
## Examples
|
||
|
||
### Showing Error Page
|
||
|
||
You can use route middleware to throw errors and show helpful error messages:
|
||
|
||
```ts [middleware/error.ts]
|
||
export default defineNuxtRouteMiddleware((to) => {
|
||
if (to.params.id === '1') {
|
||
throw createError({ statusCode: 404, statusMessage: 'Page Not Found' })
|
||
}
|
||
})
|
||
```
|
||
|
||
The above route middleware will redirect a user to the custom error page defined in the `~/error.vue` file, and expose the error message and code passed from the middleware.
|
||
|
||
### Redirection
|
||
|
||
You can use `useState` in combination with `navigateTo` helper function inside the route middleware to redirect users to different routes based on their authentication status:
|
||
|
||
```ts [middleware/auth.ts]
|
||
export default defineNuxtRouteMiddleware((to, from) => {
|
||
const auth = useState('auth')
|
||
|
||
if (!auth.value.isAuthenticated) {
|
||
return navigateTo('/login')
|
||
}
|
||
|
||
return navigateTo('/dashboard')
|
||
})
|
||
```
|
||
|
||
Both [navigateTo](/api/utils/navigate-to) and [abortNavigation](/api/utils/abort-navigation) are globally available helper functions that you can use inside `defineNuxtRouteMiddleware`.
|