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

useNavigate.test-d.tsx

65 lines1.6 KB

1import { expectTypeOf, test } from 'vitest'
2import { createRootRoute, createRoute, createRouter, useNavigate } from '../src'
3​
4const rootRoute = createRootRoute()
5​
6const indexRoute = createRoute({
7 getParentRoute: () => rootRoute,
8 path: '/',
9})
10​
11const invoicesRoute = createRoute({
12 getParentRoute: () => rootRoute,
13 path: 'invoices',
14})
15​
16const invoicesIndexRoute = createRoute({
17 getParentRoute: () => invoicesRoute,
18 path: '/',
19})
20​
21const invoiceRoute = createRoute({
22 getParentRoute: () => invoicesRoute,
23 path: '$invoiceId',
24 validateSearch: () => ({ page: 0 }),
25})
26​
27const routeTree = rootRoute.addChildren([
28 invoicesRoute.addChildren([invoicesIndexRoute, invoiceRoute]),
29 indexRoute,
30])
31​
32const defaultRouter = createRouter({
33 routeTree,
34})
35​
36type DefaultRouter = typeof defaultRouter
37​
38test('when navigating to a route', () => {
39 const navigate = useNavigate()
40​
41 expectTypeOf(navigate<DefaultRouter, '/invoices'>)
42 .parameter(0)
43 .toHaveProperty('to')
44 .toEqualTypeOf<'/' | '/invoices' | '/invoices/$invoiceId' | '.' | '..'>()
45})
46​
47test('when setting a default from', () => {
48 expectTypeOf(useNavigate<DefaultRouter, '/'>)
49 .parameter(0)
50 .exclude<undefined>()
51 .toHaveProperty('from')
52 .toEqualTypeOf<
53 '/invoices' | '/' | '/invoices/$invoiceId' | '/invoices/' | undefined
54 >()
55})
56​
57test('when setting an invalid default from', () => {
58 expectTypeOf(useNavigate<DefaultRouter, '/invalid'>)
59 .parameter(0)
60 .exclude<undefined>()
61 .toHaveProperty('from')
62 .toEqualTypeOf<
63 '/invoices' | '/' | '/invoices/$invoiceId' | '/invoices/' | undefined
64 >()
65})