Open History to see the last commit
1import { useMatch } from './useMatch'
2import type {
3 StructuralSharingOption,
4 ValidateSelected,
5} from './structuralSharing'
6import type {
7 AnyRouter,
8 RegisteredRouter,
9 ResolveUseLoaderDeps,
10 StrictOrFrom,
11 UseLoaderDepsResult,
12} from '@tanstack/router-core'
13β
14export interface UseLoaderDepsBaseOptions<
15 TRouter extends AnyRouter,
16 TFrom,
17 TSelected,
18 TStructuralSharing,
19> {
20 select?: (
21 deps: ResolveUseLoaderDeps<TRouter, TFrom>,
22 ) => ValidateSelected<TRouter, TSelected, TStructuralSharing>
23}
24β
25export type UseLoaderDepsOptions<
26 TRouter extends AnyRouter,
27 TFrom extends string | undefined,
28 TSelected,
29 TStructuralSharing,
30> = StrictOrFrom<TRouter, TFrom> &
31 UseLoaderDepsBaseOptions<TRouter, TFrom, TSelected, TStructuralSharing> &
32 StructuralSharingOption<TRouter, TSelected, TStructuralSharing>
33β
34export type UseLoaderDepsRoute<out TId> = <
35 TRouter extends AnyRouter = RegisteredRouter,
36 TSelected = unknown,
37 TStructuralSharing extends boolean = boolean,
38>(
39 opts?: UseLoaderDepsBaseOptions<TRouter, TId, TSelected, TStructuralSharing> &
40 StructuralSharingOption<TRouter, TSelected, TStructuralSharing>,
41) => UseLoaderDepsResult<TRouter, TId, TSelected>
42β
43/**
44 * Read and select the current route's loader dependencies object.
45 *
46 * Options:
47 * - `from`: Choose which route's loader deps to read
48 * - `select`: Map the deps to a derived value
49 * - `structuralSharing`: Enable structural sharing for stable references
50 *
51 * @returns The loader deps (or selected value) for the matched route.
52 * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLoaderDepsHook
53 */
54export function useLoaderDeps<
55 TRouter extends AnyRouter = RegisteredRouter,
56 const TFrom extends string | undefined = undefined,
57 TSelected = unknown,
58 TStructuralSharing extends boolean = boolean,
59>(
60 opts: UseLoaderDepsOptions<TRouter, TFrom, TSelected, TStructuralSharing>,
61): UseLoaderDepsResult<TRouter, TFrom, TSelected> {
62 const { select, ...rest } = opts
63 return useMatch({
64 ...rest,
65 select: (match) => {
66 return select ? select(match.loaderDeps) : match.loaderDeps
67 },
68 }) as UseLoaderDepsResult<TRouter, TFrom, TSelected>
69}