kdu-router 3.0.7 → 3.1.7

package/types/router.d.ts

@@ -1,127 +1,145 @@
-import Kdu, { ComponentOptions, PluginFunction, AsyncComponent } from "kdu";
+import Kdu, { ComponentOptions, PluginFunction, AsyncComponent } from 'kdu'
 
-type Component = ComponentOptions<Kdu> | typeof Kdu | AsyncComponent;
-type Dictionary<T> = { [key: string]: T };
-type ErrorHandler = (err: Error) => void;
+type Component = ComponentOptions<Kdu> | typeof Kdu | AsyncComponent
+type Dictionary < T > = { [key: string]: T }
+type ErrorHandler = (err: Error) => void
 
-export type RouterMode = "hash" | "history" | "abstract";
-export type RawLocation = string | Location;
-export type RedirectOption = RawLocation | ((to: Route) => RawLocation);
-export type NavigationGuard<V extends Kdu = Kdu> = (
+export type RouterMode = 'hash' | 'history' | 'abstract'
+export type RawLocation = string | Location
+export type RedirectOption = RawLocation | ((to: Route) => RawLocation)
+export type NavigationGuard < V extends Kdu = Kdu > = (
   to: Route,
   from: Route,
   next: (to?: RawLocation | false | ((vm: V) => any) | void) => void
 ) => any
 
 export declare class KduRouter {
-  constructor (options?: RouterOptions);
+  constructor(options?: RouterOptions)
 
-  app: Kdu;
-  mode: RouterMode;
-  currentRoute: Route;
+  app: Kdu
+  mode: RouterMode
+  currentRoute: Route
 
-  beforeEach (guard: NavigationGuard): Function;
-  beforeResolve (guard: NavigationGuard): Function;
-  afterEach (hook: (to: Route, from: Route) => any): Function;
-  push (location: RawLocation, onComplete?: Function, onAbort?: ErrorHandler): void;
-  replace (location: RawLocation, onComplete?: Function, onAbort?: ErrorHandler): void;
-  go (n: number): void;
-  back (): void;
-  forward (): void;
-  getMatchedComponents (to?: RawLocation | Route): Component[];
-  onReady (cb: Function, errorCb?: ErrorHandler): void;
-  onError (cb: ErrorHandler): void;
-  addRoutes (routes: RouteConfig[]): void;
-  resolve (to: RawLocation, current?: Route, append?: boolean): {
-    location: Location;
-    route: Route;
-    href: string;
+  beforeEach(guard: NavigationGuard): Function
+  beforeResolve(guard: NavigationGuard): Function
+  afterEach(hook: (to: Route, from: Route) => any): Function
+  push(location: RawLocation): Promise<Route>
+  replace(location: RawLocation): Promise<Route>
+  push(
+    location: RawLocation,
+    onComplete?: Function,
+    onAbort?: ErrorHandler
+  ): void
+  replace(
+    location: RawLocation,
+    onComplete?: Function,
+    onAbort?: ErrorHandler
+  ): void
+  go(n: number): void
+  back(): void
+  forward(): void
+  getMatchedComponents(to?: RawLocation | Route): Component[]
+  onReady(cb: Function, errorCb?: ErrorHandler): void
+  onError(cb: ErrorHandler): void
+  addRoutes(routes: RouteConfig[]): void
+  resolve(
+    to: RawLocation,
+    current?: Route,
+    append?: boolean
+  ): {
+    location: Location
+    route: Route
+    href: string
     // backwards compat
-    normalizedTo: Location;
-    resolved: Route;
-  };
+    normalizedTo: Location
+    resolved: Route
+  }
 
-  static install: PluginFunction<never>;
+  static install: PluginFunction<never>
 }
 
-type Position = { x: number, y: number };
-type PositionResult = Position | { selector: string, offset?: Position } | void;
+type Position = { x: number; y: number }
+type PositionResult = Position | { selector: string; offset?: Position } | void
 
 export interface RouterOptions {
-  routes?: RouteConfig[];
-  mode?: RouterMode;
-  fallback?: boolean;
-  base?: string;
-  linkActiveClass?: string;
-  linkExactActiveClass?: string;
-  parseQuery?: (query: string) => Object;
-  stringifyQuery?: (query: Object) => string;
+  routes?: RouteConfig[]
+  mode?: RouterMode
+  fallback?: boolean
+  base?: string
+  linkActiveClass?: string
+  linkExactActiveClass?: string
+  parseQuery?: (query: string) => Object
+  stringifyQuery?: (query: Object) => string
   scrollBehavior?: (
     to: Route,
     from: Route,
     savedPosition: Position | void
-  ) => PositionResult | Promise<PositionResult>;
+  ) => PositionResult | Promise<PositionResult> | undefined | null
 }
 
-type RoutePropsFunction = (route: Route) => Object;
+type RoutePropsFunction = (route: Route) => Object
 
 export interface PathToRegexpOptions {
-  sensitive?: boolean;
-  strict?: boolean;
-  end?: boolean;
+  sensitive?: boolean
+  strict?: boolean
+  end?: boolean
 }
 
 export interface RouteConfig {
-  path: string;
-  name?: string;
-  component?: Component;
-  components?: Dictionary<Component>;
-  redirect?: RedirectOption;
-  alias?: string | string[];
-  children?: RouteConfig[];
-  meta?: any;
-  beforeEnter?: NavigationGuard;
-  props?: boolean | Object | RoutePropsFunction;
-  caseSensitive?: boolean;
-  pathToRegexpOptions?: PathToRegexpOptions;
+  path: string
+  name?: string
+  component?: Component
+  components?: Dictionary<Component>
+  redirect?: RedirectOption
+  alias?: string | string[]
+  children?: RouteConfig[]
+  meta?: any
+  beforeEnter?: NavigationGuard
+  props?: boolean | Object | RoutePropsFunction
+  caseSensitive?: boolean
+  pathToRegexpOptions?: PathToRegexpOptions
 }
 
 export interface RouteRecord {
-  path: string;
-  regex: RegExp;
-  components: Dictionary<Component>;
-  instances: Dictionary<Kdu>;
-  name?: string;
-  parent?: RouteRecord;
-  redirect?: RedirectOption;
-  matchAs?: string;
-  meta: any;
+  path: string
+  regex: RegExp
+  components: Dictionary<Component>
+  instances: Dictionary<Kdu>
+  name?: string
+  parent?: RouteRecord
+  redirect?: RedirectOption
+  matchAs?: string
+  meta: any
   beforeEnter?: (
     route: Route,
     redirect: (location: RawLocation) => void,
     next: () => void
-  ) => any;
-  props: boolean | Object | RoutePropsFunction | Dictionary<boolean | Object | RoutePropsFunction>;
+  ) => any
+  props:
+    | boolean
+    | Object
+    | RoutePropsFunction
+    | Dictionary<boolean | Object | RoutePropsFunction>
 }
 
 export interface Location {
-  name?: string;
-  path?: string;
-  hash?: string;
-  query?: Dictionary<string | (string | null)[] | null | undefined>;
-  params?: Dictionary<string>;
-  append?: boolean;
-  replace?: boolean;
+  name?: string
+  path?: string
+  hash?: string
+  query?: Dictionary<string | (string | null)[] | null | undefined>
+  params?: Dictionary<string>
+  append?: boolean
+  replace?: boolean
 }
 
 export interface Route {
-  path: string;
-  name?: string;
-  hash: string;
-  query: Dictionary<string | (string | null)[]>;
-  params: Dictionary<string>;
-  fullPath: string;
-  matched: RouteRecord[];
-  redirectedFrom?: string;
-  meta?: any;
+  path: string
+  name?: string | null
+  hash: string
+  query: Dictionary<string | (string | null)[]>
+  params: Dictionary<string>
+  fullPath: string
+  matched: RouteRecord[]
+  redirectedFrom?: string
+  meta?: any
 }