gil-wiki/reference/4.api/3.utils/abort-navigation.md

title, description, links

title	description	links
abortNavigation	abortNavigation is a helper function that prevents navigation from taking place and throws an error if one is set as a parameter.	label icon to size Source i-simple-icons-github https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/router.ts xs

::warning abortNavigation is only usable inside a route middleware handler. ::

Type

export function abortNavigation (err?: Error | string): false

Parameters

err

• Type: Error | string

  Optional error to be thrown by abortNavigation.

Examples

The example below shows how you can use abortNavigation in a route middleware to prevent unauthorized route access:

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 as a String

You can pass the error as a string:

export default defineNuxtRouteMiddleware((to, from) => {
  const user = useState('user')

  if (!user.value.isAuthorized) {
    return abortNavigation('Insufficient permissions.')
  }
})

err as an Error Object

You can pass the error as an Error object, e.g. caught by the catch-block:

export default defineNuxtRouteMiddleware((to, from) => {
  try {
    /* code that might throw an error */
  } catch (err) {
    return abortNavigation(err)
  }
})