fix(types): add missing NavigationFailure types

posva · posva · commit fda70673397a · 2020-08-13T13:42:18.000+02:00
Close #3293
diff --git a/src/util/errors.js b/src/util/errors.js
@@ -1,3 +1,4 @@
+// When changing thing, also edit router.d.ts
 export const NavigationFailureType = {
   redirected: 2,
   aborted: 4,
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -13,5 +13,7 @@ export {
   Location,
   Route,
   NavigationGuard,
-  NavigationGuardNext
+  NavigationGuardNext,
+  NavigationFailureType,
+  NavigationFailure
 } from './router'
diff --git a/types/router.d.ts b/types/router.d.ts
@@ -21,7 +21,7 @@ export declare class VueRouter {
   constructor(options?: RouterOptions)
 
   app: Vue
-  options: RouterOptions;
+  options: RouterOptions
   mode: RouterMode
   currentRoute: Route
 
@@ -63,15 +63,24 @@ export declare class VueRouter {
   static install: PluginFunction<never>
   static version: string
 
-  static isNavigationFailure: (error: any, type?: NavigationFailureTypeE) => error is Error
-  static NavigationFailureType: NavigationFailureTypeE
+  static isNavigationFailure: (
+    error: any,
+    type?: number
+  ) => error is NavigationFailure
+  static NavigationFailureType: NavigationFailureType
 }
 
-export enum NavigationFailureTypeE {
-  redirected = 1,
-  aborted = 2,
-  cancelled = 3,
-  duplicated = 4
+export enum NavigationFailureType {
+  redirected= 2,
+  aborted= 4,
+  cancelled= 8,
+  duplicated= 16
+}
+
+export interface NavigationFailure extends Error {
+  to: Route
+  from: Route
+  type: number
 }
 
 type Position = { x: number; y: number }
diff --git a/types/test/index.ts b/types/test/index.ts
@@ -1,7 +1,13 @@
 import Vue, { ComponentOptions, AsyncComponent } from 'vue'
 
 import VueRouter from '../index'
-import { Route, RouteRecord, RedirectOption } from '../index'
+import {
+  Route,
+  RouteRecord,
+  RedirectOption,
+  NavigationFailure,
+  NavigationFailureType
+} from '../index'
 
 Vue.use(VueRouter)
 
@@ -11,6 +17,14 @@ const Bar = { template: '<div>bar</div>' }
 const Abc = { template: '<div>abc</div>' }
 const Async = () => Promise.resolve({ template: '<div>async</div>' })
 
+let err: any
+if (VueRouter.isNavigationFailure(err, NavigationFailureType.aborted)) {
+  err.from.fullPath.split('/')
+}
+
+let navigationFailure = new Error() as NavigationFailure
+navigationFailure.to.fullPath.split('/')
+
 const Hook: ComponentOptions<Vue> = {
   template: '<div>hook</div>',
 
@@ -181,8 +195,16 @@ router.push({
 })
 router.replace({ name: 'home' })
 
-router.push('/', () => {}, () => {})
-router.replace('/foo', () => {}, () => {})
+router.push(
+  '/',
+  () => {},
+  () => {}
+)
+router.replace(
+  '/foo',
+  () => {},
+  () => {}
+)
 
 // promises
 
@@ -204,7 +226,8 @@ router.forward()
 const Components: (
   | ComponentOptions<Vue>
   | typeof Vue
-  | AsyncComponent)[] = router.getMatchedComponents()
+  | AsyncComponent
+)[] = router.getMatchedComponents()
 
 const vm = new Vue({
   router,

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// When changing thing, also edit router.d.ts`
`1`	`2`	`export const NavigationFailureType = {`
`2`	`3`	`redirected: 2,`
`3`	`4`	`aborted: 4,`