abortNavigation
abortNavigation 是一个辅助函数,用于阻止导航发生,如果设置了错误参数,则会抛出一个错误。
abortNavigation
只能在路由中间件处理程序中使用。类型
abortNavigation(err?: Error | string): false
参数
err
- 类型:
Error
|string
可选错误,由abortNavigation
抛出。
示例
以下示例展示了如何在路由中间件中使用 abortNavigation
来阻止未经授权的路由访问
middleware/auth.ts
export default defineNuxtRouteMiddleware((to, from) => {
const user = useState('user')
if (!user.value.isAuthorized) {
return abortNavigation()
}
if (to.path !== '/edit-post') {
return navigateTo('/edit-post')
}
})
err
作为字符串
你可以将错误作为字符串传递
middleware/auth.ts
export default defineNuxtRouteMiddleware((to, from) => {
const user = useState('user')
if (!user.value.isAuthorized) {
return abortNavigation('Insufficient permissions.')
}
})
err
作为错误对象
你可以将错误作为 Error
对象传递,例如由 catch
代码块捕获的错误
middleware/auth.ts
export default defineNuxtRouteMiddleware((to, from) => {
try {
/* code that might throw an error */
} catch (err) {
return abortNavigation(err)
}
})