Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

useRouterState.test-d.tsx

114 lines2.7 KB

1import { expectTypeOf, test } from 'vitest'
2import {
3 createRootRoute,
4 createRoute,
5 createRouter,
6 useRouterState,
7} from '../src'
8import type { RouterState } from '../src'
9​
10const rootRoute = createRootRoute({
11 validateSearch: () => ({
12 page: 0,
13 }),
14})
15​
16const indexRoute = createRoute({
17 getParentRoute: () => rootRoute,
18 path: '/',
19})
20​
21const invoicesRoute = createRoute({
22 getParentRoute: () => rootRoute,
23 path: 'invoices',
24})
25​
26const invoicesIndexRoute = createRoute({
27 getParentRoute: () => invoicesRoute,
28 path: '/',
29})
30​
31const invoiceRoute = createRoute({
32 getParentRoute: () => invoicesRoute,
33 path: '$invoiceId',
34 validateSearch: () => ({ page: 0 }),
35})
36​
37const routeTree = rootRoute.addChildren([
38 invoicesRoute.addChildren([invoicesIndexRoute, invoiceRoute]),
39 indexRoute,
40])
41​
42const defaultRouter = createRouter({
43 routeTree,
44})
45​
46type DefaultRouter = typeof defaultRouter
47​
48test('can select router state', () => {
49 expectTypeOf(useRouterState<DefaultRouter>)
50 .returns.toHaveProperty('location')
51 .toMatchTypeOf<{
52 search: { page?: number | undefined }
53 }>()
54​
55 expectTypeOf(useRouterState<DefaultRouter, { func: () => void }>)
56 .parameter(0)
57 .exclude<undefined>()
58 .toHaveProperty('select')
59 .toEqualTypeOf<
60 | ((search: RouterState<DefaultRouter['routeTree']>) => {
61 func: () => void
62 })
63 | undefined
64 >()
65​
66 expectTypeOf(useRouterState<DefaultRouter, { func: () => void }>)
67 .parameter(0)
68 .exclude<undefined>()
69 .toHaveProperty('structuralSharing')
70 .toEqualTypeOf<false | undefined>()
71​
72 expectTypeOf(useRouterState<DefaultRouter, { func: () => void }, true>)
73 .parameter(0)
74 .exclude<undefined>()
75 .toHaveProperty('select')
76 .toEqualTypeOf<
77 | ((search: RouterState<DefaultRouter['routeTree']>) => {
78 func: 'Function is not serializable'
79 })
80 | undefined
81 >()
82​
83 expectTypeOf(useRouterState<DefaultRouter, { func: () => void }, true>)
84 .parameter(0)
85 .exclude<undefined>()
86 .toHaveProperty('structuralSharing')
87 .toEqualTypeOf<false | undefined>()
88​
89 const routerWithStructuralSharing = createRouter({
90 routeTree,
91 defaultStructuralSharing: true,
92 })
93​
94 expectTypeOf(
95 useRouterState<typeof routerWithStructuralSharing, { func: () => void }>,
96 )
97 .parameter(0)
98 .exclude<undefined>()
99 .toHaveProperty('select')
100 .toEqualTypeOf<
101 | ((search: RouterState<DefaultRouter['routeTree']>) => {
102 func: 'Function is not serializable'
103 })
104 | undefined
105 >()
106​
107 expectTypeOf(
108 useRouterState<typeof routerWithStructuralSharing, { func: () => void }>,
109 )
110 .parameter(0)
111 .exclude<undefined>()
112 .toHaveProperty('structuralSharing')
113 .toEqualTypeOf<false>()
114})