Types: Missing options on instance.$router

[Mister-Hope]

Version

3.1.6

Steps to reproduce

this.$router.options // should be the options that user passed to vue-rotuer

Solution

I think we should change

declare module 'vue/types/vue' {
  interface Vue {
    $router: VueRouter
    $route: Route
  }
}

to

import { RouterOptions } from './router'

declare module 'vue/types/vue' {
  interface Vue {
    $router: VueRouter & { options: RouterOptions }
    $route: Route
  }
}

[posva]

As said in #2051, it's a private API. What do you need to read from $options?

[Mister-Hope]

routes.

I am making a plugin, so I am not expecting that the user provides me his options.

[posva]

I see. Retrieving the routes is the only thing I've seen so far and it will be covered by vuejs/rfcs#122. While dynamic routing won't added to vue router 3, it's possible to add the getRoutes function here to retrieve the list of records once that RFC reaches a final comments state. It will also have routes dynamically added by the user in a normalised format, which is not the case for router.options

[Mister-Hope]

I see. Retrieving the routes is the only thing I've seen so far and it will be covered by vuejs/rfcs#122. While dynamic routing won't added to vue router 3, it's possible to add the getRoutes function here to retrieve the list of records once that RFC reaches a final comments state. It will also have routes dynamically added by the user in a normalised format, which is not the case for router.options

Wow, getRoutes function is pretty cool