index.d.ts 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. import {Component,PluginFunction,Location,Route,Animation,H5,APP,RouteConfig,RouterOptions} from './options'
  2. /**
  3. * 路由挂载点
  4. * @param {VueComponent } Vim vue实例对象
  5. * @param {dom} el dom节点选择器
  6. */
  7. declare const RouterMount: (Vim: any, el: string | Element) => void;
  8. declare class Router {
  9. constructor(options:RouterOptions)
  10. /**
  11. * 当前的 Route
  12. */
  13. get $Route():Route;
  14. /**
  15. * 获取 url 参数帮助类实例
  16. */
  17. get $parseQuery():object;
  18. /**
  19. * 获取当前是否处于正在跳转的状态
  20. * H5 状态下始终为false
  21. */
  22. get $lockStatus():boolean;
  23. /**
  24. * 动态设置拦截状态
  25. */
  26. set $lockStatus(status:boolean);
  27. /**动态的导航到一个新 URL 保留浏览历史
  28. * navigateTo
  29. * @param {Object} rule
  30. */
  31. push(rule: Location | string): void;
  32. /**动态的导航到一个新 URL 关闭当前页面,跳转到的某个页面。
  33. * redirectTo
  34. * @param {Object} rule
  35. */
  36. replace(rule:Location | string):void;
  37. /**动态的导航到一个新 URL 关闭所有页面,打开到应用内的某个页面
  38. * reLaunch
  39. * @param {Object} rule
  40. */
  41. replaceAll(rule:Location | string):void;
  42. /**动态的导航到一个新 url 关闭所有页面,打开到应用内的某个tab
  43. * @param {Object} rule
  44. */
  45. pushTab(rule:Location | string) :void;
  46. /**
  47. * 返回到指定层级页面上
  48. */
  49. back(backLayer?:number,delta?:Object):void
  50. /**
  51. * 获取当前页面下的 Route 信息
  52. * @param {Object} Vim 当前开发者可以传递一个 vue 组件对象 来获取当前下的 Route 信息
  53. */
  54. getPageRoute(Vim?:Component) : Route
  55. /**
  56. * 注册的全局前置生命周期
  57. * @param hooks 注册的全局前置生命周期函数
  58. */
  59. beforeEach(hooks:Function) : Function
  60. /**
  61. * 注册的全局后置生命周期
  62. * @param hooks 注册的全局后置生命周期函数
  63. */
  64. afterEach(hooks:Function) : Function
  65. static install:PluginFunction<never>
  66. }
  67. declare module "vue/types/vue" {
  68. interface Vue {
  69. $Router: Router;
  70. $Route: Route;
  71. }
  72. }
  73. export default Router;
  74. export {
  75. RouterMount,
  76. Location,
  77. Route,
  78. Animation,
  79. H5,
  80. APP,
  81. RouteConfig,
  82. RouterOptions
  83. }