Open History to see the last commit
1/* istanbul ignore file */
2β
3import type {
4 DefaultError,
5 DefinedInfiniteQueryObserverResult,
6 DefinedQueryObserverResult,
7 InfiniteQueryObserverOptions,
8 InfiniteQueryObserverResult,
9 MutateFunction,
10 MutationObserverOptions,
11 MutationObserverResult,
12 OmitKeyof,
13 Override,
14 QueryKey,
15 QueryObserverOptions,
16 QueryObserverResult,
17 SkipToken,
18} from '@tanstack/query-core'
19β
20export type AnyUseBaseQueryOptions = UseBaseQueryOptions<
21 any,
22 any,
23 any,
24 any,
25 any
26>
27export interface UseBaseQueryOptions<
28 TQueryFnData = unknown,
29 TError = DefaultError,
30 TData = TQueryFnData,
31 TQueryData = TQueryFnData,
32 TQueryKey extends QueryKey = QueryKey,
33> extends QueryObserverOptions<
34 TQueryFnData,
35 TError,
36 TData,
37 TQueryData,
38 TQueryKey
39 > {
40 /**
41 * Set this to `false` to unsubscribe this observer from updates to the query cache.
42 * Defaults to `true`.
43 */
44 subscribed?: boolean
45}
46β
47export type AnyUseQueryOptions = UseQueryOptions<any, any, any, any>
48export interface UseQueryOptions<
49 TQueryFnData = unknown,
50 TError = DefaultError,
51 TData = TQueryFnData,
52 TQueryKey extends QueryKey = QueryKey,
53> extends OmitKeyof<
54 UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
55 'suspense'
56 > {}
57β
58export type AnyUseSuspenseQueryOptions = UseSuspenseQueryOptions<
59 any,
60 any,
61 any,
62 any
63>
64export interface UseSuspenseQueryOptions<
65 TQueryFnData = unknown,
66 TError = DefaultError,
67 TData = TQueryFnData,
68 TQueryKey extends QueryKey = QueryKey,
69> extends OmitKeyof<
70 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
71 'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'
72 > {
73 queryFn?: Exclude<
74 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
75 SkipToken
76 >
77}
78β
79export type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<
80 any,
81 any,
82 any,
83 any,
84 any,
85 any
86>
87export interface UseInfiniteQueryOptions<
88 TQueryFnData = unknown,
89 TError = DefaultError,
90 TData = TQueryFnData,
91 TQueryData = TQueryFnData,
92 TQueryKey extends QueryKey = QueryKey,
93 TPageParam = unknown,
94> extends OmitKeyof<
95 InfiniteQueryObserverOptions<
96 TQueryFnData,
97 TError,
98 TData,
99 TQueryData,
100 TQueryKey,
101 TPageParam
102 >,
103 'suspense'
104 > {
105 /**
106 * Set this to `false` to unsubscribe this observer from updates to the query cache.
107 * Defaults to `true`.
108 */
109 subscribed?: boolean
110}
111β
112export type AnyUseSuspenseInfiniteQueryOptions =
113 UseSuspenseInfiniteQueryOptions<any, any, any, any, any, any>
114export interface UseSuspenseInfiniteQueryOptions<
115 TQueryFnData = unknown,
116 TError = DefaultError,
117 TData = TQueryFnData,
118 TQueryData = TQueryFnData,
119 TQueryKey extends QueryKey = QueryKey,
120 TPageParam = unknown,
121> extends OmitKeyof<
122 UseInfiniteQueryOptions<
123 TQueryFnData,
124 TError,
125 TData,
126 TQueryData,
127 TQueryKey,
128 TPageParam
129 >,
130 'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'
131 > {
132 queryFn?: Exclude<
133 UseInfiniteQueryOptions<
134 TQueryFnData,
135 TError,
136 TData,
137 TQueryData,
138 TQueryKey,
139 TPageParam
140 >['queryFn'],
141 SkipToken
142 >
143}
144β
145export type UseBaseQueryResult<
146 TData = unknown,
147 TError = DefaultError,
148> = QueryObserverResult<TData, TError>
149β
150export type UseQueryResult<
151 TData = unknown,
152 TError = DefaultError,
153> = UseBaseQueryResult<TData, TError>
154β
155export type UseSuspenseQueryResult<
156 TData = unknown,
157 TError = DefaultError,
158> = OmitKeyof<
159 DefinedQueryObserverResult<TData, TError>,
160 'isPlaceholderData' | 'promise'
161>
162β
163export type DefinedUseQueryResult<
164 TData = unknown,
165 TError = DefaultError,
166> = DefinedQueryObserverResult<TData, TError>
167β
168export type UseInfiniteQueryResult<
169 TData = unknown,
170 TError = DefaultError,
171> = InfiniteQueryObserverResult<TData, TError>
172β
173export type DefinedUseInfiniteQueryResult<
174 TData = unknown,
175 TError = DefaultError,
176> = DefinedInfiniteQueryObserverResult<TData, TError>
177β
178export type UseSuspenseInfiniteQueryResult<
179 TData = unknown,
180 TError = DefaultError,
181> = OmitKeyof<
182 DefinedInfiniteQueryObserverResult<TData, TError>,
183 'isPlaceholderData' | 'promise'
184>
185β
186export type AnyUseMutationOptions = UseMutationOptions<any, any, any, any>
187export interface UseMutationOptions<
188 TData = unknown,
189 TError = DefaultError,
190 TVariables = void,
191 TContext = unknown,
192> extends OmitKeyof<
193 MutationObserverOptions<TData, TError, TVariables, TContext>,
194 '_defaulted'
195 > {}
196β
197export type UseMutateFunction<
198 TData = unknown,
199 TError = DefaultError,
200 TVariables = void,
201 TContext = unknown,
202> = (
203 ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
204) => void
205β
206export type UseMutateAsyncFunction<
207 TData = unknown,
208 TError = DefaultError,
209 TVariables = void,
210 TContext = unknown,
211> = MutateFunction<TData, TError, TVariables, TContext>
212β
213export type UseBaseMutationResult<
214 TData = unknown,
215 TError = DefaultError,
216 TVariables = unknown,
217 TContext = unknown,
218> = Override<
219 MutationObserverResult<TData, TError, TVariables, TContext>,
220 { mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
221> & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }
222β
223export type UseMutationResult<
224 TData = unknown,
225 TError = DefaultError,
226 TVariables = unknown,
227 TContext = unknown,
228> = UseBaseMutationResult<TData, TError, TVariables, TContext>