Open History to see the last commit
1import { useMatch } from './useMatch'
2import type { Accessor } from 'solid-js'
3import type {
4 AnyRouter,
5 RegisteredRouter,
6 ResolveUseLoaderDeps,
7 StrictOrFrom,
8 UseLoaderDepsResult,
9} from '@tanstack/router-core'
10β
11export interface UseLoaderDepsBaseOptions<
12 TRouter extends AnyRouter,
13 TFrom,
14 TSelected,
15> {
16 select?: (deps: ResolveUseLoaderDeps<TRouter, TFrom>) => TSelected
17}
18β
19export type UseLoaderDepsOptions<
20 TRouter extends AnyRouter,
21 TFrom extends string | undefined,
22 TSelected,
23> = StrictOrFrom<TRouter, TFrom> &
24 UseLoaderDepsBaseOptions<TRouter, TFrom, TSelected>
25β
26export type UseLoaderDepsRoute<out TId> = <
27 TRouter extends AnyRouter = RegisteredRouter,
28 TSelected = unknown,
29>(
30 opts?: UseLoaderDepsBaseOptions<TRouter, TId, TSelected>,
31) => Accessor<UseLoaderDepsResult<TRouter, TId, TSelected>>
32β
33export function useLoaderDeps<
34 TRouter extends AnyRouter = RegisteredRouter,
35 const TFrom extends string | undefined = undefined,
36 TSelected = unknown,
37>(
38 opts: UseLoaderDepsOptions<TRouter, TFrom, TSelected>,
39): Accessor<UseLoaderDepsResult<TRouter, TFrom, TSelected>> {
40 return useMatch({
41 ...opts,
42 select: (match) => {
43 return opts.select ? opts.select(match.loaderDeps) : match.loaderDeps
44 },
45 }) as Accessor<UseLoaderDepsResult<TRouter, TFrom, TSelected>>
46}