update type declarations for navigation guard signature change

Author: yyx990803

flow/declarations.js

@@ -7,6 +7,12 @@ declare module 'path-to-regexp' {
 
 declare type Dictionary<T> = { [key: string]: T }
 
+declare type NavigationGuard = (
+  to: Route,
+  from: Route,
+  next: (to?: RawLocation | false | Function | void) => void
+) => any
+
 declare type RouterOptions = {
   routes?: Array<RouteConfig>;
   mode?: string;

src/history/base.js

@@ -52,7 +52,7 @@ export class History {
       activated
     } = resolveQueue(this.current.matched, route.matched)
 
-    const queue = [].concat(
+    const queue: Array<?NavigationGuard> = [].concat(
       // in-component leave guards
       extractLeaveGuards(deactivated),
       // global before hooks
@@ -64,7 +64,7 @@ export class History {
     )
 
     this.pending = route
-    const iterator = (hook, next) => {
+    const iterator = (hook: NavigationGuard, next) => {
       if (this.pending !== route) return
       hook(route, current, (to: any) => {
         if (to === false) {

src/index.js

@@ -17,8 +17,8 @@ export default class VueRouter {
   history: HashHistory | HTML5History | AbstractHistory;
   match: Matcher;
   fallback: boolean;
-  beforeHooks: Array<?Function>;
-  afterHooks: Array<?Function>;
+  beforeHooks: Array<?NavigationGuard>;
+  afterHooks: Array<?((to: Route, from: Route) => any)>;
 
   constructor (options: RouterOptions = {}) {
     this.app = null

src/util/async.js

@@ -1,6 +1,6 @@
 /* @flow */
 
-export function runQueue (queue: Array<any>, fn: Function, cb: Function) {
+export function runQueue (queue: Array<?NavigationGuard>, fn: Function, cb: Function) {
   const step = index => {
     if (index >= queue.length) {
       cb()

types/index.d.ts

@@ -12,6 +12,7 @@ declare namespace VueRouter {
   export type RouteRecord = R.RouteRecord;
   export type Location = R.Location;
   export type Route = R.Route;
+  export type NavigationGuard = R.NavigationGuard;
 }
 
 // TS cannot merge imported class with namespace, declare a subclass to bypass

types/router.d.ts

@@ -7,6 +7,11 @@ type Dictionary<T> = { [key: string]: T };
 export type RouterMode = "hash" | "history" | "abstract";
 export type RawLocation = string | Location;
 export type RedirectOption = RawLocation | ((to: Route) => RawLocation);
+export type NavigationGuard = (
+  to: Route,
+  from: Route,
+  next: (to?: RawLocation | false | ((vm: Vue) => any) | void) => void
+) => any
 
 declare class VueRouter {
   constructor (options?: RouterOptions);
@@ -15,14 +20,8 @@ declare class VueRouter {
   mode: RouterMode;
   currentRoute: Route;
 
-  beforeEach (
-    guard: (
-      route: Route,
-      redirect: (location: RawLocation) => void,
-      next: () => void
-    ) => any
-  ): void;
-  afterEach (hook: (route: Route) => any): void;
+  beforeEach (guard: NavigationGuard): void;
+  afterEach (hook: (to: Route, from: Route) => any): void;
   push (location: RawLocation): void;
   replace (location: RawLocation): void;
   go (n: number): void;
@@ -54,11 +53,7 @@ export interface RouteConfig {
   alias?: string | string[];
   children?: RouteConfig[];
   meta?: any;
-  beforeEnter?: (
-    route: Route,
-    redirect: (location: RawLocation) => void,
-    next: () => void
-  ) => any;
+  beforeEnter?: NavigationGuard;
 }
 
 export interface RouteRecord {

types/test/index.ts

@@ -10,20 +10,22 @@ const Home = { template: "<div>home</div>" };
 const Foo = { template: "<div>foo</div>" };
 const Bar = { template: "<div>bar</div>" };
 
-const Hook: ComponentOptions<{ a: string } & Vue> = {
+const Hook: ComponentOptions<Vue> = {
   template: "<div>hook</div>",
 
-  beforeRouteEnter (route, redirect, next) {
+  beforeRouteEnter (to, from, next) {
     route.params;
-    redirect("/");
+    next("/");
+    next({ path: "/" });
     next(vm => {
-      vm.a = "done";
+      vm.$router;
     });
   },
 
-  beforeRouteLeave (route, redirect, next) {
+  beforeRouteLeave (to, from, next) {
     route.params;
-    redirect("/");
+    next("/");
+    next({ path: "/" });
     next();
   }
 };
@@ -54,9 +56,10 @@ const router = new VueRouter({
           bar: Bar
         },
         meta: { auth: true },
-        beforeEnter (route, redirect, next) {
-          route.params;
-          redirect({ name: "home" });
+        beforeEnter (to, from, next) {
+          to.params;
+          from.params;
+          next({ name: "home" });
           next();
         }
       },
@@ -98,14 +101,15 @@ matched.forEach(m => {
   const redirect: RedirectOption | undefined = m.redirect;
 });
 
-router.beforeEach((route, redirect, next) => {
-  route.params;
-  redirect("/");
+router.beforeEach((to, from, next) => {
+  to.params;
+  next("/");
   next();
 });
 
-router.afterEach(route => {
-  route.params;
+router.afterEach((to, from) => {
+  to.params;
+  from.params;
 });
 
 router.push({

types/vue.d.ts

@@ -4,7 +4,7 @@
 
 import Vue = require("vue");
 import VueRouter = require("./index");
-import { Route, RawLocation } from "./index";
+import { Route, RawLocation, NavigationGuard } from "./index";
 
 declare module "vue/types/vue" {
   interface Vue {
@@ -16,19 +16,7 @@ declare module "vue/types/vue" {
 declare module "vue/types/options" {
   interface ComponentOptions<V extends Vue> {
     router?: VueRouter;
-
-    beforeRouteEnter?: (
-      this: never,
-      route: Route,
-      redirect: (location: RawLocation) => void,
-      next: (callback: (vm: V) => any) => void
-    ) => any;
-
-    beforeRouteLeave?: (
-      this: V,
-      route: Route,
-      redirect: (location: RawLocation) => void,
-      next: () => void
-    ) => any;
+    beforeRouteEnter?: NavigationGuard;
+    beforeRouteLeave?: NavigationGuard;
   }
 }