@kevisual/router 0.0.6-alpha-5 → 0.0.7

package/dist/router-browser.d.ts

@@ -93,6 +93,9 @@ type RouteOpts = {
     run?: Run;
     nextRoute?: NextRoute;
     description?: string;
+    metadata?: {
+        [key: string]: any;
+    };
     middleware?: Route[] | string[];
     type?: 'route' | 'middleware';
     /**
@@ -112,6 +115,9 @@ type RouteOpts = {
     isVerify?: boolean;
     verify?: (ctx?: RouteContext, dev?: boolean) => boolean;
     verifyKey?: (key: string, ctx?: RouteContext, dev?: boolean) => boolean;
+    /**
+     * $#$ will be used to split path and key
+     */
     idUsePath?: boolean;
     isDebug?: boolean;
 };
@@ -121,13 +127,22 @@ type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
 declare class Route<U = {
     [key: string]: any;
 }> {
+    /**
+     * 一级路径
+     */
     path?: string;
+    /**
+     * 二级路径
+     */
     key?: string;
     id?: string;
     share?: boolean;
     run?: Run;
     nextRoute?: NextRoute;
     description?: string;
+    metadata?: {
+        [key: string]: any;
+    };
     middleware?: (Route | string)[];
     type?: string;
     private _validator?;
@@ -135,7 +150,13 @@ declare class Route<U = {
         [key: string]: Schema<any>;
     };
     data?: any;
+    /**
+     * 是否需要验证
+     */
     isVerify?: boolean;
+    /**
+     * 是否开启debug，开启后会打印错误信息
+     */
     isDebug?: boolean;
     constructor(path: string, key?: string, opts?: RouteOpts);
     private createSchema;
@@ -208,7 +229,7 @@ declare class QueryRouter {
      */
     remove(route: Route | {
         path: string;
-        key: string;
+        key?: string;
     }): void;
     /**
      * remove route by id
@@ -292,6 +313,9 @@ declare class QueryRouter {
     importRoutes(routes: Route[]): void;
     importRouter(router: QueryRouter): void;
     throw(code?: number | string, message?: string, tips?: string): void;
+    hasRoute(path: string, key?: string): Route<{
+        [key: string]: any;
+    }>;
 }
 type QueryRouterServerOpts = {
     handleFn?: HandleFn;