mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-11 08:33:53 +00:00
docs(api): add abortNavigation
docs (#4164)
This commit is contained in:
parent
6205fbe316
commit
f69a67472a
@ -1,7 +1,16 @@
|
||||
# `abortNavigation`
|
||||
|
||||
```ts
|
||||
abortNavigation(err?: Error | string): false
|
||||
```
|
||||
|
||||
* **err**: Optional error to be thrown by `abortNavigation()`.
|
||||
|
||||
::alert{type="warning"}
|
||||
`abortNavigation()` is only usable inside a [route middleware handler](/guide/directory-structure/middleware).
|
||||
::
|
||||
|
||||
Inside a route middleware handler, `abortNavigation()` will abort navigation, and throw an error if one is set as a parameter.
|
||||
|
||||
::ReadMore{link="/guide/features/routing"}
|
||||
::
|
||||
|
||||
::NeedContribution
|
||||
::
|
||||
|
Loading…
Reference in New Issue
Block a user