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 MutationObserverResult,
11 OmitKeyof,
12 Override,
13 QueryKey,
14 QueryObserverOptions,
15 QueryObserverResult,
16} from '@tanstack/query-core'
17import type { Signal } from '@angular/core'
18import type { MapToSignals } from './signal-proxy'
19β
20/**
21 * @public
22 */
23export interface CreateBaseQueryOptions<
24 TQueryFnData = unknown,
25 TError = DefaultError,
26 TData = TQueryFnData,
27 TQueryData = TQueryFnData,
28 TQueryKey extends QueryKey = QueryKey,
29> extends QueryObserverOptions<
30 TQueryFnData,
31 TError,
32 TData,
33 TQueryData,
34 TQueryKey
35 > {}
36β
37/**
38 * @public
39 */
40export interface CreateQueryOptions<
41 TQueryFnData = unknown,
42 TError = DefaultError,
43 TData = TQueryFnData,
44 TQueryKey extends QueryKey = QueryKey,
45> extends OmitKeyof<
46 CreateBaseQueryOptions<
47 TQueryFnData,
48 TError,
49 TData,
50 TQueryFnData,
51 TQueryKey
52 >,
53 'suspense'
54 > {}
55β
56/**
57 * @public
58 */
59type CreateStatusBasedQueryResult<
60 TStatus extends QueryObserverResult['status'],
61 TData = unknown,
62 TError = DefaultError,
63> = Extract<QueryObserverResult<TData, TError>, { status: TStatus }>
64β
65/**
66 * @public
67 */
68export interface BaseQueryNarrowing<TData = unknown, TError = DefaultError> {
69 isSuccess: (
70 this: CreateBaseQueryResult<TData, TError>,
71 ) => this is CreateBaseQueryResult<
72 TData,
73 TError,
74 CreateStatusBasedQueryResult<'success', TData, TError>
75 >
76 isError: (
77 this: CreateBaseQueryResult<TData, TError>,
78 ) => this is CreateBaseQueryResult<
79 TData,
80 TError,
81 CreateStatusBasedQueryResult<'error', TData, TError>
82 >
83 isPending: (
84 this: CreateBaseQueryResult<TData, TError>,
85 ) => this is CreateBaseQueryResult<
86 TData,
87 TError,
88 CreateStatusBasedQueryResult<'pending', TData, TError>
89 >
90}
91β
92/**
93 * @public
94 */
95export interface CreateInfiniteQueryOptions<
96 TQueryFnData = unknown,
97 TError = DefaultError,
98 TData = TQueryFnData,
99 TQueryData = TQueryFnData,
100 TQueryKey extends QueryKey = QueryKey,
101 TPageParam = unknown,
102> extends OmitKeyof<
103 InfiniteQueryObserverOptions<
104 TQueryFnData,
105 TError,
106 TData,
107 TQueryData,
108 TQueryKey,
109 TPageParam
110 >,
111 'suspense'
112 > {}
113β
114/**
115 * @public
116 */
117export type CreateBaseQueryResult<
118 TData = unknown,
119 TError = DefaultError,
120 TState = QueryObserverResult<TData, TError>,
121> = BaseQueryNarrowing<TData, TError> &
122 MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, 'safely'>>
123β
124/**
125 * @public
126 */
127export type CreateQueryResult<
128 TData = unknown,
129 TError = DefaultError,
130> = CreateBaseQueryResult<TData, TError>
131β
132/**
133 * @public
134 */
135export type DefinedCreateQueryResult<
136 TData = unknown,
137 TError = DefaultError,
138 TState = DefinedQueryObserverResult<TData, TError>,
139> = BaseQueryNarrowing<TData, TError> &
140 MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, 'safely'>>
141β
142/**
143 * @public
144 */
145export type CreateInfiniteQueryResult<
146 TData = unknown,
147 TError = DefaultError,
148> = MapToSignals<InfiniteQueryObserverResult<TData, TError>>
149β
150/**
151 * @public
152 */
153export type DefinedCreateInfiniteQueryResult<
154 TData = unknown,
155 TError = DefaultError,
156 TDefinedInfiniteQueryObserver = DefinedInfiniteQueryObserverResult<
157 TData,
158 TError
159 >,
160> = MapToSignals<TDefinedInfiniteQueryObserver>
161β
162/**
163 * @public
164 */
165export type CreateMutateFunction<
166 TData = unknown,
167 TError = DefaultError,
168 TVariables = void,
169 TContext = unknown,
170> = (
171 ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
172) => void
173β
174/**
175 * @public
176 */
177export type CreateMutateAsyncFunction<
178 TData = unknown,
179 TError = DefaultError,
180 TVariables = void,
181 TContext = unknown,
182> = MutateFunction<TData, TError, TVariables, TContext>
183β
184/**
185 * @public
186 */
187export type CreateBaseMutationResult<
188 TData = unknown,
189 TError = DefaultError,
190 TVariables = unknown,
191 TContext = unknown,
192> = Override<
193 MutationObserverResult<TData, TError, TVariables, TContext>,
194 { mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
195> & {
196 mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
197}
198β
199/**
200 * @public
201 */
202type CreateStatusBasedMutationResult<
203 TStatus extends CreateBaseMutationResult['status'],
204 TData = unknown,
205 TError = DefaultError,
206 TVariables = unknown,
207 TContext = unknown,
208> = Extract<
209 CreateBaseMutationResult<TData, TError, TVariables, TContext>,
210 { status: TStatus }
211>
212β
213type SignalFunction<T extends () => any> = T & Signal<ReturnType<T>>
214β
215/**
216 * @public
217 */
218export interface BaseMutationNarrowing<
219 TData = unknown,
220 TError = DefaultError,
221 TVariables = unknown,
222 TContext = unknown,
223> {
224 isSuccess: SignalFunction<
225 (
226 this: CreateMutationResult<TData, TError, TVariables, TContext>,
227 ) => this is CreateMutationResult<
228 TData,
229 TError,
230 TVariables,
231 TContext,
232 CreateStatusBasedMutationResult<
233 'success',
234 TData,
235 TError,
236 TVariables,
237 TContext
238 >
239 >
240 >
241 isError: SignalFunction<
242 (
243 this: CreateMutationResult<TData, TError, TVariables, TContext>,
244 ) => this is CreateMutationResult<
245 TData,
246 TError,
247 TVariables,
248 TContext,
249 CreateStatusBasedMutationResult<
250 'error',
251 TData,
252 TError,
253 TVariables,
254 TContext
255 >
256 >
257 >
258 isPending: SignalFunction<
259 (
260 this: CreateMutationResult<TData, TError, TVariables, TContext>,
261 ) => this is CreateMutationResult<
262 TData,
263 TError,
264 TVariables,
265 TContext,
266 CreateStatusBasedMutationResult<
267 'pending',
268 TData,
269 TError,
270 TVariables,
271 TContext
272 >
273 >
274 >
275 isIdle: SignalFunction<
276 (
277 this: CreateMutationResult<TData, TError, TVariables, TContext>,
278 ) => this is CreateMutationResult<
279 TData,
280 TError,
281 TVariables,
282 TContext,
283 CreateStatusBasedMutationResult<
284 'idle',
285 TData,
286 TError,
287 TVariables,
288 TContext
289 >
290 >
291 >
292}
293β
294/**
295 * @public
296 */
297export type CreateMutationResult<
298 TData = unknown,
299 TError = DefaultError,
300 TVariables = unknown,
301 TContext = unknown,
302 TState = CreateStatusBasedMutationResult<
303 CreateBaseMutationResult['status'],
304 TData,
305 TError,
306 TVariables,
307 TContext
308 >,
309> = BaseMutationNarrowing<TData, TError, TVariables, TContext> &
310 MapToSignals<OmitKeyof<TState, keyof BaseMutationNarrowing, 'safely'>>
311β
312/**
313 * @public
314 */
315export type NonUndefinedGuard<T> = T extends undefined ? never : T