@ray-js/router-mp/lib/Router.d.ts

Ray Core

import type { RouteOptions, Router as TRouter } from '@ray-js/types';
import { RouterScheduler } from './RouterScheduler';
export declare class Router implements TRouter {
    private urlPrefix;
    /**
     * 功能页模式为 functional，使用相对路径模式
     * 如果是绝对路径，表示跳转到宿主小程序
     *
     * @private
     */
    private mode;
    /**
     * setUrlPrefix
     */
    setUrlPrefix(prefix: string): void;
    setMode(mode: string): void;
    scheduler: RouterScheduler;
    /**
     * 标准化路由路径，将 web 标准的地址栏转化到 小程序地址
     */
    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;
    reload(): void;
    go(delta: number): void;
    back(): void;
    get href(): string;
}
export declare const router: Router;