`enhanceApp()` `ctx.router` is not a router instance

[davestewart]

Describe the bug

The theme docs and code completion state that the router instance is exposed in enhanceApp() but it appears the router instance is actually a route instance, and doesn't conform to the Router interface.

Reproduction

Initialize a new project, then add the following code to enhanceApp():

    console.log({ router })
    router.onAfterRouteChanged((to: string) => {
      console.log(`changed to: ${to}`)
    })

Expected behavior

We should be able to interact with the router instance

System Info

System:
    OS: macOS 14.5
    CPU: (12) arm64 Apple M3 Pro
    Memory: 213.02 MB / 36.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 20.15.1 - /usr/local/bin/node
    Yarn: 1.22.22 - /usr/local/bin/yarn
    npm: 10.7.0 - /usr/local/bin/npm
    pnpm: 8.15.6 - /usr/local/bin/pnpm
  Browsers:
    Brave Browser: 122.1.63.169
    Chrome: 128.0.6613.138
    Chrome Canary: 130.0.6720.0
    Edge: 128.0.2739.79
    Safari: 17.5
  npmPackages:
    vitepress: ^1.3.4 => 1.3.4

Additional context

No response

Validations

• [X] Check if you're on the latest VitePress version.
• [X] Follow our Code of Conduct
• [X] Read the docs.
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

[brc-dd]

Ah, it's router, but that function is not exactly a hook. You need to define it - https://github.com/vuejs/vitepress/pull/2564#issue-1783819597

router.onBeforeRouteChange = (to) => {
  console.log('onBeforeRouteChange', to)
}

[davestewart]

Aha! Yes, I think defo a docs issue.

Thanks for coming back so very quickly!!! 🥰