feat(types): add types for getRoutes addRoute

vuejs · Jan 4, 2021 · fb9bb60 · fb9bb60
1 parent 6bc30aa
commit fb9bb60
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -10,6 +10,7 @@ export {
   RouterOptions,
   RouteConfig,
   RouteRecord,
+  RouteRecordPublic,
   Location,
   Route,
   NavigationGuard,

diff --git a/types/router.d.ts b/types/router.d.ts
@@ -47,6 +47,11 @@ export declare class VueRouter {
   onReady(cb: Function, errorCb?: ErrorHandler): void
   onError(cb: ErrorHandler): void
   addRoutes(routes: RouteConfig[]): void
+
+  addRoute(parent: string, route: RouteConfig): void
+  addRoute(route: RouteConfig): void
+  getRoutes(): RouteRecordPublic[]
+
   resolve(
     to: RawLocation,
     current?: Route,
@@ -158,6 +163,26 @@ export interface RouteRecord {
     | Dictionary<boolean | Object | RoutePropsFunction>
 }
 
+export interface RouteRecordPublic {
+  path: string
+  components: Dictionary<Component>
+  instances: Dictionary<Vue>
+  name?: string
+  redirect?: RedirectOption
+  meta: any
+  beforeEnter?: (
+    route: Route,
+    redirect: (location: RawLocation) => void,
+    next: () => void
+  ) => any
+  props:
+    | boolean
+    | Object
+    | RoutePropsFunction
+    | Dictionary<boolean | Object | RoutePropsFunction>
+}
+
+
 export interface Location {
   name?: string
   path?: string