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

infiniteQueryOptions.ts

106 lines2.2 KB

1import type {
2 DataTag,
3 DefaultError,
4 InfiniteData,
5 NonUndefinedGuard,
6 QueryKey,
7} from '@tanstack/query-core'
8import type { SolidInfiniteQueryOptions } from './types'
9import type { Accessor } from 'solid-js'
10​
11export type UndefinedInitialDataInfiniteOptions<
12 TQueryFnData,
13 TError = DefaultError,
14 TData = InfiniteData<TQueryFnData>,
15 TQueryKey extends QueryKey = QueryKey,
16 TPageParam = unknown,
17> = Accessor<
18 SolidInfiniteQueryOptions<
19 TQueryFnData,
20 TError,
21 TData,
22 TQueryKey,
23 TPageParam
24 > & {
25 initialData?: undefined
26 }
28​
29export type DefinedInitialDataInfiniteOptions<
30 TQueryFnData,
31 TError = DefaultError,
32 // should we handle page param correctly
33 TData = InfiniteData<TQueryFnData>,
34 TQueryKey extends QueryKey = QueryKey,
35 TPageParam = unknown,
36> = Accessor<
37 SolidInfiniteQueryOptions<
38 TQueryFnData,
39 TError,
40 TData,
41 TQueryKey,
42 TPageParam
43 > & {
44 initialData:
45 | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
46 | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)
47 }
49export function infiniteQueryOptions<
50 TQueryFnData,
51 TError = DefaultError,
52 TData = InfiniteData<TQueryFnData>,
53 TQueryKey extends QueryKey = QueryKey,
54 TPageParam = unknown,
55>(
56 options: ReturnType<
57 DefinedInitialDataInfiniteOptions<
58 TQueryFnData,
59 TError,
60 TData,
61 TQueryKey,
62 TPageParam
63 >
64 >,
65): ReturnType<
66 DefinedInitialDataInfiniteOptions<
67 TQueryFnData,
68 TError,
69 TData,
70 TQueryKey,
71 TPageParam
72 >
73> & {
74 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
76export function infiniteQueryOptions<
77 TQueryFnData,
78 TError = DefaultError,
79 TData = InfiniteData<TQueryFnData>,
80 TQueryKey extends QueryKey = QueryKey,
81 TPageParam = unknown,
82>(
83 options: ReturnType<
84 UndefinedInitialDataInfiniteOptions<
85 TQueryFnData,
86 TError,
87 TData,
88 TQueryKey,
89 TPageParam
90 >
91 >,
92): ReturnType<
93 UndefinedInitialDataInfiniteOptions<
94 TQueryFnData,
95 TError,
96 TData,
97 TQueryKey,
98 TPageParam
99 >
100> & {
101 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
103​
104export function infiniteQueryOptions(options: unknown) {
105 return options