From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Mon, 11 May 2020 07:08:56 +0000 (+0200)
Subject: refactor(types): rename NavigationGuardCallback to NavigationGuardNext
X-Git-Tag: v4.0.0-alpha.11~12
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f1ceadfaa36e15e2f3bb09af20bc15aed7b9ae1b;p=thirdparty%2Fvuejs%2Frouter.git

refactor(types): rename NavigationGuardCallback to NavigationGuardNext
---

diff --git a/src/index.ts b/src/index.ts
index 54473dee..9c452e3d 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -31,7 +31,7 @@ export {
   RouteLocationOptions,
   RouteRecordRaw,
   NavigationGuard,
-  NavigationGuardCallback,
+  NavigationGuardNext,
   PostNavigationGuard,
 } from './types'
 export {
diff --git a/src/navigationGuards.ts b/src/navigationGuards.ts
index 9695dd71..f1c96a76 100644
--- a/src/navigationGuards.ts
+++ b/src/navigationGuards.ts
@@ -1,7 +1,7 @@
 import {
   NavigationGuard,
   RouteLocationNormalized,
-  NavigationGuardCallback,
+  NavigationGuardNext,
   RouteLocationRaw,
   RouteLocationNormalizedLoaded,
   NavigationGuardNextCallback,
@@ -95,7 +95,7 @@ export function guardToPromiseFn(
 ): () => Promise<void> {
   return () =>
     new Promise((resolve, reject) => {
-      const next: NavigationGuardCallback = (
+      const next: NavigationGuardNext = (
         valid?: boolean | RouteLocationRaw | NavigationGuardNextCallback | Error
       ) => {
         if (valid === false)
@@ -140,10 +140,10 @@ export function guardToPromiseFn(
 }
 
 function canOnlyBeCalledOnce(
-  next: NavigationGuardCallback,
+  next: NavigationGuardNext,
   to: RouteLocationNormalized,
   from: RouteLocationNormalized
-): NavigationGuardCallback {
+): NavigationGuardNext {
   let called = 0
   return function () {
     if (called++ === 1)
diff --git a/src/types/index.ts b/src/types/index.ts
index 04fb2f7d..ca62b34d 100644
--- a/src/types/index.ts
+++ b/src/types/index.ts
@@ -237,7 +237,7 @@ export interface MatcherLocation
     'name' | 'path' | 'params' | 'matched' | 'meta'
   > {}
 
-export interface NavigationGuardCallback {
+export interface NavigationGuardNext {
   (): void
   (error: Error): void
   (location: RouteLocationRaw): void
@@ -252,7 +252,7 @@ export interface NavigationGuard {
     // TODO: we could maybe add extra information like replace: true/false
     to: RouteLocationNormalized,
     from: RouteLocationNormalized,
-    next: NavigationGuardCallback
+    next: NavigationGuardNext
   ): any
 }
 
@@ -261,7 +261,7 @@ export interface NavigationGuardWithThis<T> {
     this: T,
     to: RouteLocationNormalized,
     from: RouteLocationNormalized,
-    next: NavigationGuardCallback
+    next: NavigationGuardNext
   ): any
 }
 
diff --git a/test-dts/createRouter.test-d.ts b/test-dts/createRouter.test-d.ts
index 1af67c2f..ca647b3e 100644
--- a/test-dts/createRouter.test-d.ts
+++ b/test-dts/createRouter.test-d.ts
@@ -2,7 +2,7 @@ import {
   createRouter,
   createWebHistory,
   NavigationGuard,
-  NavigationGuardCallback,
+  NavigationGuardNext,
   RouteLocationNormalized,
 } from './index'
 import { createApp, defineComponent } from 'vue'
@@ -24,7 +24,7 @@ export const loggedInGuard: NavigationGuard = (to, from, next) => next('/')
 function beforeGuardFn(
   to: RouteLocationNormalized,
   from: RouteLocationNormalized,
-  next: NavigationGuardCallback
+  next: NavigationGuardNext
 ) {}
 
 router.beforeEach(loggedInGuard)