Open History to see the last commit
1import type {
2 DataTag,
3 DefaultError,
4 InfiniteData,
5 InitialDataFunction,
6 OmitKeyof,
7 QueryKey,
8 SkipToken,
9} from '@tanstack/query-core'
10import type { UseInfiniteQueryOptions } from './types'
11β
12export type UndefinedInitialDataInfiniteOptions<
13 TQueryFnData,
14 TError = DefaultError,
15 TData = InfiniteData<TQueryFnData>,
16 TQueryKey extends QueryKey = QueryKey,
17 TPageParam = unknown,
18> = UseInfiniteQueryOptions<
19 TQueryFnData,
20 TError,
21 TData,
22 TQueryFnData,
23 TQueryKey,
24 TPageParam
25> & {
26 initialData?:
27 | undefined
28 | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
29 | InitialDataFunction<
30 NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
31 >
32}
33β
34export type UnusedSkipTokenInfiniteOptions<
35 TQueryFnData,
36 TError = DefaultError,
37 TData = InfiniteData<TQueryFnData>,
38 TQueryKey extends QueryKey = QueryKey,
39 TPageParam = unknown,
40> = OmitKeyof<
41 UseInfiniteQueryOptions<
42 TQueryFnData,
43 TError,
44 TData,
45 TQueryFnData,
46 TQueryKey,
47 TPageParam
48 >,
49 'queryFn'
50> & {
51 queryFn?: Exclude<
52 UseInfiniteQueryOptions<
53 TQueryFnData,
54 TError,
55 TData,
56 TQueryFnData,
57 TQueryKey,
58 TPageParam
59 >['queryFn'],
60 SkipToken | undefined
61 >
62}
63β
64type NonUndefinedGuard<T> = T extends undefined ? never : T
65β
66export type DefinedInitialDataInfiniteOptions<
67 TQueryFnData,
68 TError = DefaultError,
69 TData = InfiniteData<TQueryFnData>,
70 TQueryKey extends QueryKey = QueryKey,
71 TPageParam = unknown,
72> = UseInfiniteQueryOptions<
73 TQueryFnData,
74 TError,
75 TData,
76 TQueryFnData,
77 TQueryKey,
78 TPageParam
79> & {
80 initialData:
81 | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
82 | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)
83 | undefined
84}
85β
86export function infiniteQueryOptions<
87 TQueryFnData,
88 TError = DefaultError,
89 TData = InfiniteData<TQueryFnData>,
90 TQueryKey extends QueryKey = QueryKey,
91 TPageParam = unknown,
92>(
93 options: DefinedInitialDataInfiniteOptions<
94 TQueryFnData,
95 TError,
96 TData,
97 TQueryKey,
98 TPageParam
99 >,
100): DefinedInitialDataInfiniteOptions<
101 TQueryFnData,
102 TError,
103 TData,
104 TQueryKey,
105 TPageParam
106> & {
107 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
108}
109β
110export function infiniteQueryOptions<
111 TQueryFnData,
112 TError = DefaultError,
113 TData = InfiniteData<TQueryFnData>,
114 TQueryKey extends QueryKey = QueryKey,
115 TPageParam = unknown,
116>(
117 options: UnusedSkipTokenInfiniteOptions<
118 TQueryFnData,
119 TError,
120 TData,
121 TQueryKey,
122 TPageParam
123 >,
124): UnusedSkipTokenInfiniteOptions<
125 TQueryFnData,
126 TError,
127 TData,
128 TQueryKey,
129 TPageParam
130> & {
131 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
132}
133β
134export function infiniteQueryOptions<
135 TQueryFnData,
136 TError = DefaultError,
137 TData = InfiniteData<TQueryFnData>,
138 TQueryKey extends QueryKey = QueryKey,
139 TPageParam = unknown,
140>(
141 options: UndefinedInitialDataInfiniteOptions<
142 TQueryFnData,
143 TError,
144 TData,
145 TQueryKey,
146 TPageParam
147 >,
148): UndefinedInitialDataInfiniteOptions<
149 TQueryFnData,
150 TError,
151 TData,
152 TQueryKey,
153 TPageParam
154> & {
155 queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>
156}
157β
158export function infiniteQueryOptions(options: unknown) {
159 return options
160}