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

useRouteContext.ts

39 lines1.0 KB

1import type { AllContext, RouteById } from './routeInfo'
2import type { AnyRouter } from './router'
3import type { Expand, StrictOrFrom } from './utils'
4​
5export interface UseRouteContextBaseOptions<
6 TRouter extends AnyRouter,
7 TFrom,
8 TStrict extends boolean,
9 TSelected,
10> {
11 select?: (
12 search: ResolveUseRouteContext<TRouter, TFrom, TStrict>,
13 ) => TSelected
15​
16export type UseRouteContextOptions<
17 TRouter extends AnyRouter,
18 TFrom extends string | undefined,
19 TStrict extends boolean,
20 TSelected,
21> = StrictOrFrom<TRouter, TFrom, TStrict> &
22 UseRouteContextBaseOptions<TRouter, TFrom, TStrict, TSelected>
23​
24export type ResolveUseRouteContext<
25 TRouter extends AnyRouter,
26 TFrom,
27 TStrict extends boolean,
28> = TStrict extends false
29 ? AllContext<TRouter['routeTree']>
30 : Expand<RouteById<TRouter['routeTree'], TFrom>['types']['allContext']>
31​
32export type UseRouteContextResult<
33 TRouter extends AnyRouter,
34 TFrom,
35 TStrict extends boolean,
36 TSelected,
37> = unknown extends TSelected
38 ? ResolveUseRouteContext<TRouter, TFrom, TStrict>
39 : TSelected