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

useBlocker.test-d.tsx

119 lines2.7 KB

1import { expectTypeOf, test } from 'vitest'
2import { createRootRoute, createRoute, createRouter, useBlocker } from '../src'
3​
4test('blocker without resolver', () => {
5 const rootRoute = createRootRoute()
6​
7 const indexRoute = createRoute({
8 getParentRoute: () => rootRoute,
9 path: '/',
10 })
11​
12 const invoicesRoute = createRoute({
13 getParentRoute: () => rootRoute,
14 path: 'invoices',
15 })
16​
17 const invoicesIndexRoute = createRoute({
18 getParentRoute: () => invoicesRoute,
19 path: '/',
20 })
21​
22 const routeTree = rootRoute.addChildren([
23 invoicesRoute.addChildren([invoicesIndexRoute]),
24 indexRoute,
25 ])
26​
27 const defaultRouter = createRouter({
28 routeTree,
29 })
30​
31 type DefaultRouter = typeof defaultRouter
32​
33 expectTypeOf(useBlocker<DefaultRouter, false>).returns.toBeVoid()
34})
35​
36test('blocker with resolver', () => {
37 const rootRoute = createRootRoute()
38​
39 const indexRoute = createRoute({
40 getParentRoute: () => rootRoute,
41 path: '/',
42 })
43​
44 const invoicesRoute = createRoute({
45 getParentRoute: () => rootRoute,
46 path: 'invoices',
47 })
48​
49 const invoicesIndexRoute = createRoute({
50 getParentRoute: () => invoicesRoute,
51 path: '/',
52 })
53​
54 const routeTree = rootRoute.addChildren([
55 invoicesRoute.addChildren([invoicesIndexRoute]),
56 indexRoute,
57 ])
58​
59 const defaultRouter = createRouter({
60 routeTree,
61 })
62​
63 type DefaultRouter = typeof defaultRouter
64​
65 expectTypeOf(useBlocker<DefaultRouter, true>).returns.toBeObject()
66})
67​
68test('shouldBlockFn has corrent action', () => {
69 const rootRoute = createRootRoute()
70​
71 const indexRoute = createRoute({
72 getParentRoute: () => rootRoute,
73 path: '/',
74 })
75​
76 const invoicesRoute = createRoute({
77 getParentRoute: () => rootRoute,
78 path: 'invoices',
79 })
80​
81 const invoicesIndexRoute = createRoute({
82 getParentRoute: () => invoicesRoute,
83 path: '/',
84 })
85​
86 const routeTree = rootRoute.addChildren([
87 invoicesRoute.addChildren([invoicesIndexRoute]),
88 indexRoute,
89 ])
90​
91 const defaultRouter = createRouter({
92 routeTree,
93 })
94​
95 type DefaultRouter = typeof defaultRouter
96​
97 expectTypeOf(useBlocker<DefaultRouter>)
98 .parameter(0)
99 .toHaveProperty('shouldBlockFn')
100 .parameter(0)
101 .toHaveProperty('action')
102 .toEqualTypeOf<'PUSH' | 'REPLACE' | 'FORWARD' | 'BACK' | 'GO'>()
103​
104 expectTypeOf(useBlocker<DefaultRouter>)
105 .parameter(0)
106 .toHaveProperty('shouldBlockFn')
107 .parameter(0)
108 .toHaveProperty('current')
109 .toHaveProperty('routeId')
110 .toEqualTypeOf<'__root__' | '/' | '/invoices' | '/invoices/'>()
111​
112 expectTypeOf(useBlocker<DefaultRouter>)
113 .parameter(0)
114 .toHaveProperty('shouldBlockFn')
115 .parameter(0)
116 .toHaveProperty('next')
117 .toHaveProperty('routeId')
118 .toEqualTypeOf<'__root__' | '/' | '/invoices' | '/invoices/'>()
119})