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

structuralSharing.ts

47 lines1.5 KB

1import type {
2 AnyRouter,
3 Constrain,
4 OptionalStructuralSharing,
5 ValidateJSON,
6} from '@tanstack/router-core'
7​
8export type DefaultStructuralSharingEnabled<TRouter extends AnyRouter> =
9 boolean extends TRouter['options']['defaultStructuralSharing']
10 ? // for now, default to false.
11 // TODO in V2: default to true
12 false
13 : NonNullable<TRouter['options']['defaultStructuralSharing']>
14​
15export interface RequiredStructuralSharing<TStructuralSharing, TConstraint> {
16 readonly structuralSharing: Constrain<TStructuralSharing, TConstraint>
18​
19export type StructuralSharingOption<
20 TRouter extends AnyRouter,
21 TSelected,
22 TStructuralSharing,
23> = unknown extends TSelected
24 ? OptionalStructuralSharing<TStructuralSharing, boolean>
25 : unknown extends TRouter['routeTree']
26 ? OptionalStructuralSharing<TStructuralSharing, boolean>
27 : TSelected extends ValidateJSON<TSelected>
28 ? OptionalStructuralSharing<TStructuralSharing, boolean>
29 : DefaultStructuralSharingEnabled<TRouter> extends true
30 ? RequiredStructuralSharing<TStructuralSharing, false>
31 : OptionalStructuralSharing<TStructuralSharing, false>
32​
33export type StructuralSharingEnabled<
34 TRouter extends AnyRouter,
35 TStructuralSharing,
36> = boolean extends TStructuralSharing
37 ? DefaultStructuralSharingEnabled<TRouter>
38 : TStructuralSharing
39​
40export type ValidateSelected<
41 TRouter extends AnyRouter,
42 TSelected,
43 TStructuralSharing,
44> =
45 StructuralSharingEnabled<TRouter, TStructuralSharing> extends true
46 ? ValidateJSON<TSelected>
47 : TSelected