vitarx-router 2.0.0 → 2.0.1

package/dist/vitarx-router.d.ts

@@ -61,6 +61,7 @@ export declare type BeforeEnterCallback = (this: Router, to: ReadonlyRouteLocati
  *
  * @param {RouterOptions} options - 配置
  * @return {RouterMemory} - `RouterMemory`内存路由器实例
+ * @see https://vitarx.cn/router/basis/threshold.html#%E5%88%9B%E5%BB%BA%E8%B7%AF%E7%94%B1%E5%99%A8%E5%AE%9E%E4%BE%8B 创建路由器实例
  */
 export declare function createRouter(options: MakeRequired<RouterOptions<'memory'>, 'mode'>): MemoryRouter;
 
@@ -96,6 +97,7 @@ export declare function createRouter(options: MakeRequired<RouterOptions<'memory
  *
  * @param {RouterOptions} options - 路由配置
  * @return {RouterHistory} - `RouterHistory`路由器实例
+ * @see https://vitarx.cn/router/basis/threshold.html#%E5%88%9B%E5%BB%BA%E8%B7%AF%E7%94%B1%E5%99%A8%E5%AE%9E%E4%BE%8B 创建路由器实例
  */
 export declare function createRouter(options: MakeRequired<RouterOptions<'path'>, 'mode'>): HistoryRouter;
 
@@ -106,8 +108,31 @@ export declare function createRouter(options: MakeRequired<RouterOptions<'path'>
  *
  * @param {RouterOptions} options - 路由配置
  * @return {RouterHistory} - `RouterHistory`路由器实例
+ * @see https://vitarx.cn/router/basis/threshold.html#%E5%88%9B%E5%BB%BA%E8%B7%AF%E7%94%B1%E5%99%A8%E5%AE%9E%E4%BE%8B 创建路由器实例
  */
-export declare function createRouter(options: RouterOptions<'hash'>): HistoryRouter;
+export declare function createRouter(options: MakeRequired<RouterOptions<'hash'>, 'mode'>): HistoryRouter;
+
+/**
+ * 创建history路由器，默认hash模式
+ *
+ * 基于History API实现路由功能，支持浏览器前进后退、刷新等操作。
+ *
+ * @param {RouterOptions} options - 路由配置
+ * @return {RouterHistory} - `RouterHistory`路由器实例
+ * @see https://vitarx.cn/router/basis/threshold.html#%E5%88%9B%E5%BB%BA%E8%B7%AF%E7%94%B1%E5%99%A8%E5%AE%9E%E4%BE%8B 创建路由器实例
+ */
+export declare function createRouter(options: Omit<RouterOptions, 'mode'>): HistoryRouter;
+
+/**
+ * 创建history路由器，默认hash模式
+ *
+ * 基于History API实现路由功能，支持浏览器前进后退、刷新等操作。
+ *
+ * @param {RouterOptions} options - 路由配置
+ * @return {RouterHistory|RouterMemory} - 返回对应的路由器实例
+ * @see https://vitarx.cn/router/basis/threshold.html#%E5%88%9B%E5%BB%BA%E8%B7%AF%E7%94%B1%E5%99%A8%E5%AE%9E%E4%BE%8B 创建路由器实例
+ */
+export declare function createRouter(options: RouterOptions): HistoryRouter | MemoryRouter;
 
 /**
  * 定义路由
@@ -115,6 +140,7 @@ export declare function createRouter(options: RouterOptions<'hash'>): HistoryRou
  * 使用defineRoute定义路由可以获得更好的代码提示。
  *
  * @param {Route} route - 路由配置
+ * @return {Route} - 路由配置
  */
 export declare function defineRoute(route: Route): Route;
 
@@ -124,6 +150,8 @@ export declare function defineRoute(route: Route): Route;
  * 使用defineRoutes定义路由表可以获得更好的代码提示。
  *
  * @param {Route[]} routes - 路由配置表
+ * @return {Route[]} - 路由配置表
+ * @see https://vitarx.cn/router/basis/route.html 定义路由
  */
 export declare function defineRoutes(...routes: Route[]): Route[];
 
@@ -909,6 +937,8 @@ export declare abstract class Router extends RouterRegistry implements AppObject
  *
  * 它只是简单的实现了一个a标签，点击后跳转到目标路由，
  * 如果有更高级的定制需求，往往你可以项目中自行编写一个小部件来实现任何你想要的效果。
+ *
+ * @see https://vitarx.cn/router/basis/navigation.html 文档
  */
 export declare class RouterLink extends Widget<RouterLinkProps> {
     /**
@@ -1266,6 +1296,8 @@ declare abstract class RouterRegistry {
  * 用于渲染路由线路配置的`widget`，可以在子组件中嵌套`RouterView`，但应用内只能存在一个根视图。
  *
  * 如需实现页面缓存等功能，可以重写该类的{@link build}方法。
+ *
+ * @see https://vitarx.cn/router/advanced/router-view.html 文档
  */
 export declare class RouterView extends Widget<RouteOptions> {
     private readonly _$index;
@@ -1439,6 +1471,7 @@ export declare interface _ScrollToOptions {
  * ```
  *
  * @return {ReadonlyRouteLocation} - 只读的`RouteLocation`对象
+ * @see https://vitarx.cn/router/basis/threshold.html#%E8%8E%B7%E5%8F%96%E5%BD%93%E5%89%8D%E8%B7%AF%E7%94%B1 获取当前路由位置对象
  */
 export declare function useRoute(): ReadonlyRouteLocation;
 
@@ -1448,7 +1481,8 @@ export declare function useRoute(): ReadonlyRouteLocation;
  * 与使用`Router.instance`静态属性获取是一致的效果。
  *
  * @return {RouterCore} - 路由器实例
- * @throws {Error} - 如果路由器实例未初始化，则抛出异常
+ * @throws {Error} - 如果未创建路由器实例，则会抛出异常
+ * @see https://vitarx.cn/router/basis/threshold.html#%E8%AE%BF%E9%97%AE%E8%B7%AF%E7%94%B1%E5%99%A8 访问路由器实例
  */
 export declare function useRouter<T extends Router>(): T;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitarx-router",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Vitarx前端框架的配套路由器",
   "author": "ZhuChongLin <8210856@qq.com>",
   "license": "MIT",