Open History to see the last commit
1import { useMatch } from './useMatch'
2import type { Accessor } from 'solid-js'
3import type {
4 AnyRouter,
5 RegisteredRouter,
6 ResolveUseParams,
7 StrictOrFrom,
8 ThrowConstraint,
9 ThrowOrOptional,
10 UseParamsResult,
11} from '@tanstack/router-core'
12β
13export interface UseParamsBaseOptions<
14 TRouter extends AnyRouter,
15 TFrom,
16 TStrict extends boolean,
17 TThrow extends boolean,
18 TSelected,
19> {
20 select?: (params: ResolveUseParams<TRouter, TFrom, TStrict>) => TSelected
21 shouldThrow?: TThrow
22}
23β
24export type UseParamsOptions<
25 TRouter extends AnyRouter,
26 TFrom extends string | undefined,
27 TStrict extends boolean,
28 TThrow extends boolean,
29 TSelected,
30> = StrictOrFrom<TRouter, TFrom, TStrict> &
31 UseParamsBaseOptions<TRouter, TFrom, TStrict, TThrow, TSelected>
32β
33export type UseParamsRoute<out TFrom> = <
34 TRouter extends AnyRouter = RegisteredRouter,
35 TSelected = unknown,
36 TThrow extends boolean = true,
37>(
38 opts?: UseParamsBaseOptions<
39 TRouter,
40 TFrom,
41 /* TStrict */ true,
42 TThrow,
43 TSelected
44 >,
45) => Accessor<
46 ThrowOrOptional<UseParamsResult<TRouter, TFrom, true, TSelected>, TThrow>
47>
48β
49export function useParams<
50 TRouter extends AnyRouter = RegisteredRouter,
51 const TFrom extends string | undefined = undefined,
52 TStrict extends boolean = true,
53 TThrow extends boolean = true,
54 TSelected = unknown,
55>(
56 opts: UseParamsOptions<
57 TRouter,
58 TFrom,
59 TStrict,
60 ThrowConstraint<TStrict, TThrow>,
61 TSelected
62 >,
63): Accessor<
64 ThrowOrOptional<UseParamsResult<TRouter, TFrom, TStrict, TSelected>, TThrow>
65> {
66 return useMatch({
67 from: opts.from!,
68 strict: opts.strict,
69 shouldThrow: opts.shouldThrow,
70 select: (match) => {
71 const params = opts.strict === false ? match.params : match._strictParams
72 return opts.select ? opts.select(params) : params
73 },
74 }) as Accessor<any>
75}