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('权限不足。')
  }
})

err 作为错误对象

您可以将错误作为 Error 对象传递,例如在 catch 块中捕获的:

middleware/auth.ts
export default defineNuxtRouteMiddleware((to, from) => {
  try {
    /* 可能会抛出错误的代码 */
  } catch (err) {
    return abortNavigation(err)
  }
})