Nuxt3 中文课程 《实战全栈开发简书》.

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)
  }
})