@ray-js/router 1.6.32 → 1.7.0

package/lib/Router.d.ts

@@ -1,5 +1,5 @@
-import { Router as TRouter, RouteOptions } from '@ray-js/types';
-import { RouterScheduler } from './RouterScheduler';
+import type { RouteOptions, Router as TRouter } from '@ray-js/types';
+import type { RouterScheduler } from './RouterScheduler';
 export declare class Router implements TRouter {
     /**
      * 页面路由调度器
@@ -13,7 +13,25 @@ export declare class Router implements TRouter {
         scheduler: RouterScheduler;
     });
     private normalizeRoute;
+    /**
+     * 跳转到指定路由
+     * @param to - routes.config.ts 中配置的路由地址
+     * @param options
+     * @param options.subpackage - 分包名
+     *
+     * @example
+     * router.push('/cat', { subpackage: 'packageA' });
+     */
     push(to: string, options?: RouteOptions): void;
+    /**
+     * 替换当前路由
+     * @param to - routes.config.ts 中配置的路由地址
+     * @param options
+     * @param options.subpackage - 分包名
+     *
+     * @example
+     * router.replace('/cat', { subpackage: 'packageA' });
+     */
     replace(to: string, options?: RouteOptions): void;
     go(delta: number): void;
     back(): void;

package/lib/Router.js

@@ -14,7 +14,7 @@ export class Router {
     // window.router = this
   }
   normalizeRoute(params) {
-    let {
+    const {
       to
     } = params;
     // FIXME: 绝对路径是否需要支持？
@@ -43,6 +43,16 @@ export class Router {
       to
     });
   }
+
+  /**
+   * 跳转到指定路由
+   * @param to - routes.config.ts 中配置的路由地址
+   * @param options
+   * @param options.subpackage - 分包名
+   *
+   * @example
+   * router.push('/cat', { subpackage: 'packageA' });
+   */
   push(to) {
     this.normalizeRoute({
       to
@@ -53,6 +63,16 @@ export class Router {
       history.push(to);
     });
   }
+
+  /**
+   * 替换当前路由
+   * @param to - routes.config.ts 中配置的路由地址
+   * @param options
+   * @param options.subpackage - 分包名
+   *
+   * @example
+   * router.replace('/cat', { subpackage: 'packageA' });
+   */
   replace(to) {
     this.normalizeRoute({
       to

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/router",
-  "version": "1.6.32",
+  "version": "1.7.0",
   "description": "Ray Core",
   "keywords": [
     "ray"
@@ -23,17 +23,17 @@
     "watch": "tsc -p ./tsconfig.build.json --module esnext --outDir lib --watch"
   },
   "dependencies": {
-    "@ray-js/library": "1.6.32",
-    "@ray-js/types": "1.6.32",
+    "@ray-js/library": "1.7.0",
+    "@ray-js/types": "1.7.0",
     "history": "^4.10.1"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.6.32",
+    "@ray-js/cli": "1.7.0",
     "@types/history": "^5.0.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.com"
   },
-  "gitHead": "364580ba2e1c75eadacd5cfbd4266ab496e444cf"
+  "gitHead": "c230e01c313aca9700e12d14b80488aae9bec3d3"
 }