Skip to content

Commit 0729ce7

Browse files
authored
fix(types): add hotUpdateCallback to auto-resolver handleHotUpdate (#2836)
1 parent 8acc2bb commit 0729ce7

3 files changed

Lines changed: 58 additions & 7 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import { describe, it, expectTypeOf } from 'vitest'
2+
import type {
3+
EXPERIMENTAL_Router,
4+
EXPERIMENTAL_RouterOptions,
5+
} from 'vue-router/experimental'
6+
import { handleHotUpdate, resolver } from 'vue-router/auto-resolver'
7+
8+
declare const router: EXPERIMENTAL_Router
9+
10+
describe('vue-router/auto-resolver', () => {
11+
it('exports the resolver', () => {
12+
expectTypeOf(resolver).toEqualTypeOf<
13+
EXPERIMENTAL_RouterOptions['resolver']
14+
>()
15+
})
16+
17+
it('handleHotUpdate accepts an optional callback with the new resolver', () => {
18+
handleHotUpdate(router)
19+
handleHotUpdate(router, newResolver => {
20+
expectTypeOf(newResolver).toEqualTypeOf<
21+
EXPERIMENTAL_RouterOptions['resolver']
22+
>()
23+
})
24+
// @ts-expect-error: the callback receives a resolver, not routes
25+
handleHotUpdate(router, (_newResolver: string) => {})
26+
})
27+
})

‎packages/router/test-dts/tsconfig.experimental.json‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@
77
"noImplicitReturns": false,
88
"paths": {
99
"vue-router": ["../dist"],
10-
"vue-router/experimental": ["../dist/experimental/index.d.ts"]
10+
"vue-router/experimental": ["../dist/experimental/index.d.ts"],
11+
"vue-router/auto-resolver": ["../vue-router-auto-resolver.d.mts"]
1112
}
1213
},
13-
// Only `experimental.test-d.ts` — it globally augments `TypesConfig.Router`
14-
// and must NOT be compiled alongside files that re-export from
15-
// `../dist`, which carries the un-augmented classic `Router`.
16-
"include": ["./experimental.test-d.ts"],
14+
// Only experimental files: `experimental.test-d.ts` globally augments
15+
// `TypesConfig.Router` and must NOT be compiled alongside files that
16+
// re-export from `../dist`, which carries the un-augmented classic `Router`.
17+
"include": ["./experimental.test-d.ts", "./auto-resolver.test-d.ts"],
1718
"exclude": [
1819
"../src",
1920
"../dist",

‎packages/router/vue-router-auto-resolver.d.mts‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,33 @@ import type {
99
} from 'vue-router/experimental'
1010

1111
/**
12-
* Handles HMR.
12+
* Setups hot module replacement for the resolver.
1313
* Generated by unplugin-vue-router
14+
*
15+
* @param router - The router instance
16+
* @param hotUpdateCallback - Callback to be called after replacing the resolver and before the navigation
17+
*
18+
* @example
19+
*
20+
* ```ts
21+
* import { createWebHistory } from 'vue-router'
22+
* import { experimental_createRouter as createRouter } from 'vue-router/experimental'
23+
* import { resolver, handleHotUpdate } from 'vue-router/auto-resolver'
24+
* const router = createRouter({
25+
* history: createWebHistory(),
26+
* resolver,
27+
* })
28+
* if (import.meta.hot) {
29+
* handleHotUpdate(router)
30+
* }
31+
* ```
1432
*/
15-
export function handleHotUpdate(router: EXPERIMENTAL_Router): void
33+
export declare function handleHotUpdate(
34+
router: EXPERIMENTAL_Router,
35+
hotUpdateCallback?: (
36+
newResolver: EXPERIMENTAL_RouterOptions['resolver']
37+
) => void
38+
): void
1639

1740
/**
1841
* Custom resolver automatically generated at build time

0 commit comments

Comments
 (0)