Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-26 07:32:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): add abortNavigation docs (#4164)

Browse Source
This commit is contained in:
Clément Ollivier 2022-04-07 15:46:30 +02:00 committed by GitHub
parent 6205fbe316
commit f69a67472a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/content/3.api/3.utils/abort-navigation.md
View File

@ -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
::