docs: reorder example

diff --git a/netlify.toml b/netlify.toml
index 17cb1132967a08481be61098b7a31713f4571fda..798623f0ae7e22535dfd3e1c1faf5caeaa3f4340 100644 (file)
--- a/netlify.toml
+++ b/netlify.toml
@@ -1,5 +1,6 @@
 [build.environment]
 CHROMEDRIVER_SKIP_DOWNLOAD = "true"
+NODE_VERSION = "18"
 
 [build]
 command = "pnpm run docs:build"

diff --git a/packages/docs/api/interfaces/Router.md b/packages/docs/api/interfaces/Router.md
index 0c8d92e259dfee9bfea62142ec8a8bcd5eabc30d..ca15e504999c726671bd8422bce1e07dc6d05c5e 100644 (file)
--- a/packages/docs/api/interfaces/Router.md
+++ b/packages/docs/api/interfaces/Router.md
@@ -100,6 +100,8 @@ function that removes the registered hook.
 
 `fn`
 
+a function that removes the registered hook
+
 ▸ (): `void`
 
 Add a navigation hook that is executed after every navigation. Returns a
@@ -109,6 +111,8 @@ function that removes the registered hook.
 
 `void`
 
+a function that removes the registered hook
+
 **`Example`**
 
 ```js
@@ -191,6 +195,8 @@ registered guard.
 
 `fn`
 
+a function that removes the registered guard
+
 ▸ (): `void`
 
 Add a navigation guard that executes before navigation is about to be
@@ -202,6 +208,8 @@ registered guard.
 
 `void`
 
+a function that removes the registered guard
+
 **`Example`**
 
 ```js

diff --git a/packages/router/src/errors.ts b/packages/router/src/errors.ts
index 2039d436203ba3e28d5e5a4a5fafec31adfd136c..773be27be26356ea494450ceac7a0bf83acc8b2a 100644 (file)
--- a/packages/router/src/errors.ts
+++ b/packages/router/src/errors.ts
@@ -144,6 +144,9 @@ export function createRouterError<E extends RouterError>(
 /**
  * Check if an object is a {@link NavigationFailure}.
  *
+ * @param error - possible {@link NavigationFailure}
+ * @param type - optional types to check for
+ *
  * @example
  * ```js
  * import { isNavigationFailure, NavigationFailureType } from 'vue-router'
@@ -163,8 +166,6 @@ export function createRouterError<E extends RouterError>(
  *   }
  * })
  * ```
- * @param error - possible {@link NavigationFailure}
- * @param type - optional types to check for
  */
 export function isNavigationFailure(
   error: any,

diff --git a/packages/router/src/router.ts b/packages/router/src/router.ts
index e3d2ed3e7f46693df5729402562a7939aa19a6cc..1d6c669756acbc3eaf279dd97529ebfee6ff5f09 100644 (file)
--- a/packages/router/src/router.ts
+++ b/packages/router/src/router.ts
@@ -287,6 +287,9 @@ export interface Router {
    * navigation guards have been successful. Returns a function that removes the
    * registered guard.
    *
+   * @param guard - navigation guard to add
+   * @returns a function that removes the registered guard
+   *
    * @example
    * ```js
    * router.beforeResolve(to => {
@@ -294,13 +297,16 @@ export interface Router {
    * })
    * ```
    *
-   * @param guard - navigation guard to add
    */
   beforeResolve(guard: NavigationGuardWithThis<undefined>): () => void
+
   /**
    * Add a navigation hook that is executed after every navigation. Returns a
    * function that removes the registered hook.
    *
+   * @param guard - navigation hook to add
+   * @returns a function that removes the registered hook
+   *
    * @example
    * ```js
    * router.afterEach((to, from, failure) => {
@@ -309,8 +315,6 @@ export interface Router {
    *   }
    * })
    * ```
-   *
-   * @param guard - navigation hook to add
    */
   afterEach(guard: NavigationHookAfter): () => void