forked from TanStack/query
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.ts
677 lines (622 loc) · 19.1 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
import type { MutationState } from './mutation'
import type { QueryBehavior, Query } from './query'
import type { RetryValue, RetryDelayValue } from './retryer'
import type { QueryFilters, QueryTypeFilter } from './utils'
export type QueryKey = readonly unknown[]
export type QueryFunction<
T = unknown,
TQueryKey extends QueryKey = QueryKey
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
export interface QueryFunctionContext<
TQueryKey extends QueryKey = QueryKey,
TPageParam = any
> {
queryKey: TQueryKey
signal?: AbortSignal
pageParam?: TPageParam
meta: QueryMeta | undefined
}
export type InitialDataFunction<T> = () => T | undefined
export type PlaceholderDataFunction<TResult> = () => TResult | undefined
export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
queryKey: TQueryKey
) => string
export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
firstPage: TQueryFnData,
allPages: TQueryFnData[]
) => unknown
export type GetNextPageParamFunction<TQueryFnData = unknown> = (
lastPage: TQueryFnData,
allPages: TQueryFnData[]
) => unknown
export interface InfiniteData<TData> {
pages: TData[]
pageParams: unknown[]
}
export type QueryMeta = Record<string, unknown>
export interface QueryOptions<
TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> {
/**
* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely., failureCount: num
* If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number.
* If set to a function `(failureCount, error) => boolean` failed queries will retry until the function returns false.
*/
retry?: RetryValue<TError>
retryDelay?: RetryDelayValue<TError>
cacheTime?: number
isDataEqual?: (oldData: TData | undefined, newData: TData) => boolean
queryFn?: QueryFunction<TQueryFnData, TQueryKey>
queryHash?: string
queryKey?: TQueryKey
queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
initialData?: TData | InitialDataFunction<TData>
initialDataUpdatedAt?: number | (() => number | undefined)
behavior?: QueryBehavior<TQueryFnData, TError, TData>
/**
* Set this to `false` to disable structural sharing between query results.
* Defaults to `true`.
*/
structuralSharing?: boolean
/**
* This function can be set to automatically get the previous cursor for infinite queries.
* The result will also be used to determine the value of `hasPreviousPage`.
*/
getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
/**
* This function can be set to automatically get the next cursor for infinite queries.
* The result will also be used to determine the value of `hasNextPage`.
*/
getNextPageParam?: GetNextPageParamFunction<TQueryFnData>
_defaulted?: boolean
/**
* Additional payload to be stored on each query.
* Use this property to pass information that can be used in other places.
*/
meta?: QueryMeta
}
export interface QueryObserverOptions<
TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
/**
* Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
* To refetch the query, use the `refetch` method returned from the `useQuery` instance.
* Defaults to `true`.
*/
enabled?: boolean
/**
* The time in milliseconds after data is considered stale.
* If set to `Infinity`, the data will never be considered stale.
*/
staleTime?: number
/**
* If set to a number, the query will continuously refetch at this frequency in milliseconds.
* If set to a function, the function will be executed with the latest data and query to compute a frequency
* Defaults to `false`.
*/
refetchInterval?:
| number
| false
| ((
data: TData | undefined,
query: Query<TQueryFnData, TError, TQueryData, TQueryKey>
) => number | false)
/**
* If set to `true`, the query will continue to refetch while their tab/window is in the background.
* Defaults to `false`.
*/
refetchIntervalInBackground?: boolean
/**
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* Defaults to `true`.
*/
refetchOnWindowFocus?: boolean | 'always'
/**
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* Defaults to `true`.
*/
refetchOnReconnect?: boolean | 'always'
/**
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, will disable additional instances of a query to trigger background refetches.
* If set to `'always'`, the query will always refetch on mount.
* Defaults to `true`.
*/
refetchOnMount?: boolean | 'always'
/**
* If set to `false`, the query will not be retried on mount if it contains an error.
* Defaults to `true`.
*/
retryOnMount?: boolean
/**
* If set, the component will only re-render if any of the listed properties change.
* When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change.
* When set to `'all'`, the component will re-render whenever a query is updated.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
*/
notifyOnChangeProps?: Array<keyof InfiniteQueryObserverResult> | 'all'
/**
* This callback will fire any time the query successfully fetches new data or the cache is updated via `setQueryData`.
*/
onSuccess?: (data: TData) => void
/**
* This callback will fire if the query encounters an error and will be passed the error.
*/
onError?: (err: TError) => void
/**
* This callback will fire any time the query is either successfully fetched or errors and be passed either the data or error.
*/
onSettled?: (data: TData | undefined, error: TError | null) => void
/**
* Whether errors should be thrown instead of setting the `error` property.
* If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary.
* If set to `false` and `suspense` is `false`, errors are returned as state.
* If set to a function, it will be passed the error and should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`).
* Defaults to `false`.
*/
useErrorBoundary?: boolean | ((error: TError) => boolean)
/**
* This option can be used to transform or select a part of the data returned by the query function.
*/
select?: (data: TQueryData) => TData
/**
* If set to `true`, the query will suspend when `status === 'loading'`
* and throw errors when `status === 'error'`.
* Defaults to `false`.
*/
suspense?: boolean
/**
* Set this to `true` to keep the previous `data` when fetching based on a new query key.
* Defaults to `false`.
*/
keepPreviousData?: boolean
/**
* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
*/
placeholderData?: TQueryData | PlaceholderDataFunction<TQueryData>
/**
* If set, the observer will optimistically set the result in fetching state before the query has actually started fetching.
* This is to make sure the results are not lagging behind.
* Defaults to `true`.
*/
optimisticResults?: boolean
}
export interface InfiniteQueryObserverOptions<
TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> extends QueryObserverOptions<
TQueryFnData,
TError,
InfiniteData<TData>,
InfiniteData<TQueryData>,
TQueryKey
> {}
export interface FetchQueryOptions<
TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> extends QueryOptions<TQueryFnData, TError, TData, TQueryKey> {
/**
* The time in milliseconds after data is considered stale.
* If the data is fresh it will be returned from the cache.
*/
staleTime?: number
}
export interface FetchInfiniteQueryOptions<
TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> extends FetchQueryOptions<
TQueryFnData,
TError,
InfiniteData<TData>,
TQueryKey
> {}
export interface ResultOptions {
throwOnError?: boolean
}
export interface RefetchPageFilters<TPageData = unknown> {
refetchPage?: (
lastPage: TPageData,
index: number,
allPages: TPageData[]
) => boolean
}
export interface RefetchOptions extends ResultOptions {
cancelRefetch?: boolean
}
export interface InvalidateQueryFilters<TPageData = unknown>
extends QueryFilters,
RefetchPageFilters<TPageData> {
refetchType?: QueryTypeFilter | 'none'
}
export interface RefetchQueryFilters<TPageData = unknown>
extends QueryFilters,
RefetchPageFilters<TPageData> {}
export interface ResetQueryFilters<TPageData = unknown>
extends QueryFilters,
RefetchPageFilters<TPageData> {}
export interface InvalidateOptions extends RefetchOptions {}
export interface ResetOptions extends RefetchOptions {}
export interface FetchNextPageOptions extends ResultOptions {
cancelRefetch?: boolean
pageParam?: unknown
}
export interface FetchPreviousPageOptions extends ResultOptions {
cancelRefetch?: boolean
pageParam?: unknown
}
export type QueryStatus = 'idle' | 'loading' | 'error' | 'success'
export interface QueryObserverBaseResult<TData = unknown, TError = unknown> {
data: TData | undefined
dataUpdatedAt: number
error: TError | null
errorUpdatedAt: number
failureCount: number
isError: boolean
isFetched: boolean
isFetchedAfterMount: boolean
isFetching: boolean
isIdle: boolean
isLoading: boolean
isLoadingError: boolean
isPlaceholderData: boolean
isPreviousData: boolean
isRefetchError: boolean
isRefetching: boolean
isStale: boolean
isSuccess: boolean
refetch: <TPageData>(
options?: RefetchOptions & RefetchQueryFilters<TPageData>
) => Promise<QueryObserverResult<TData, TError>>
remove: () => void
status: QueryStatus
}
export interface QueryObserverIdleResult<TData = unknown, TError = unknown>
extends QueryObserverBaseResult<TData, TError> {
data: undefined
error: null
isError: false
isIdle: true
isLoading: false
isLoadingError: false
isRefetchError: false
isSuccess: false
status: 'idle'
}
export interface QueryObserverLoadingResult<TData = unknown, TError = unknown>
extends QueryObserverBaseResult<TData, TError> {
data: undefined
error: null
isError: false
isIdle: false
isLoading: true
isLoadingError: false
isRefetchError: false
isSuccess: false
status: 'loading'
}
export interface QueryObserverLoadingErrorResult<
TData = unknown,
TError = unknown
> extends QueryObserverBaseResult<TData, TError> {
data: undefined
error: TError
isError: true
isIdle: false
isLoading: false
isLoadingError: true
isRefetchError: false
isSuccess: false
status: 'error'
}
export interface QueryObserverRefetchErrorResult<
TData = unknown,
TError = unknown
> extends QueryObserverBaseResult<TData, TError> {
data: TData
error: TError
isError: true
isIdle: false
isLoading: false
isLoadingError: false
isRefetchError: true
isSuccess: false
status: 'error'
}
export interface QueryObserverSuccessResult<TData = unknown, TError = unknown>
extends QueryObserverBaseResult<TData, TError> {
data: TData
error: null
isError: false
isIdle: false
isLoading: false
isLoadingError: false
isRefetchError: false
isSuccess: true
status: 'success'
}
export type QueryObserverResult<TData = unknown, TError = unknown> =
| QueryObserverIdleResult<TData, TError>
| QueryObserverLoadingErrorResult<TData, TError>
| QueryObserverLoadingResult<TData, TError>
| QueryObserverRefetchErrorResult<TData, TError>
| QueryObserverSuccessResult<TData, TError>
export interface InfiniteQueryObserverBaseResult<
TData = unknown,
TError = unknown
> extends QueryObserverBaseResult<InfiniteData<TData>, TError> {
fetchNextPage: (
options?: FetchNextPageOptions
) => Promise<InfiniteQueryObserverResult<TData, TError>>
fetchPreviousPage: (
options?: FetchPreviousPageOptions
) => Promise<InfiniteQueryObserverResult<TData, TError>>
hasNextPage?: boolean
hasPreviousPage?: boolean
isFetchingNextPage: boolean
isFetchingPreviousPage: boolean
}
export interface InfiniteQueryObserverIdleResult<
TData = unknown,
TError = unknown
> extends InfiniteQueryObserverBaseResult<TData, TError> {
data: undefined
error: null
isError: false
isIdle: true
isLoading: false
isLoadingError: false
isRefetchError: false
isSuccess: false
status: 'idle'
}
export interface InfiniteQueryObserverLoadingResult<
TData = unknown,
TError = unknown
> extends InfiniteQueryObserverBaseResult<TData, TError> {
data: undefined
error: null
isError: false
isIdle: false
isLoading: true
isLoadingError: false
isRefetchError: false
isSuccess: false
status: 'loading'
}
export interface InfiniteQueryObserverLoadingErrorResult<
TData = unknown,
TError = unknown
> extends InfiniteQueryObserverBaseResult<TData, TError> {
data: undefined
error: TError
isError: true
isIdle: false
isLoading: false
isLoadingError: true
isRefetchError: false
isSuccess: false
status: 'error'
}
export interface InfiniteQueryObserverRefetchErrorResult<
TData = unknown,
TError = unknown
> extends InfiniteQueryObserverBaseResult<TData, TError> {
data: InfiniteData<TData>
error: TError
isError: true
isIdle: false
isLoading: false
isLoadingError: false
isRefetchError: true
isSuccess: false
status: 'error'
}
export interface InfiniteQueryObserverSuccessResult<
TData = unknown,
TError = unknown
> extends InfiniteQueryObserverBaseResult<TData, TError> {
data: InfiniteData<TData>
error: null
isError: false
isIdle: false
isLoading: false
isLoadingError: false
isRefetchError: false
isSuccess: true
status: 'success'
}
export type InfiniteQueryObserverResult<TData = unknown, TError = unknown> =
| InfiniteQueryObserverIdleResult<TData, TError>
| InfiniteQueryObserverLoadingErrorResult<TData, TError>
| InfiniteQueryObserverLoadingResult<TData, TError>
| InfiniteQueryObserverRefetchErrorResult<TData, TError>
| InfiniteQueryObserverSuccessResult<TData, TError>
export type MutationKey = readonly unknown[]
export type MutationStatus = 'idle' | 'loading' | 'success' | 'error'
export type MutationMeta = Record<string, unknown>
export type MutationFunction<TData = unknown, TVariables = unknown> = (
variables: TVariables
) => Promise<TData>
export interface MutationOptions<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> {
mutationFn?: MutationFunction<TData, TVariables>
mutationKey?: MutationKey
variables?: TVariables
onMutate?: (
variables: TVariables
) => Promise<TContext | undefined> | TContext | undefined
onSuccess?: (
data: TData,
variables: TVariables,
context: TContext
) => Promise<unknown> | void
onError?: (
error: TError,
variables: TVariables,
context: TContext | undefined
) => Promise<unknown> | void
onSettled?: (
data: TData | undefined,
error: TError | null,
variables: TVariables,
context: TContext | undefined
) => Promise<unknown> | void
retry?: RetryValue<TError>
retryDelay?: RetryDelayValue<TError>
cacheTime?: number
_defaulted?: boolean
meta?: MutationMeta
}
export interface MutationObserverOptions<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> extends MutationOptions<TData, TError, TVariables, TContext> {
useErrorBoundary?: boolean | ((error: TError) => boolean)
}
export interface MutateOptions<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> {
onSuccess?: (
data: TData,
variables: TVariables,
context: TContext
) => Promise<unknown> | void
onError?: (
error: TError,
variables: TVariables,
context: TContext | undefined
) => Promise<unknown> | void
onSettled?: (
data: TData | undefined,
error: TError | null,
variables: TVariables,
context: TContext | undefined
) => Promise<unknown> | void
}
export type MutateFunction<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> = (
variables: TVariables,
options?: MutateOptions<TData, TError, TVariables, TContext>
) => Promise<TData>
export interface MutationObserverBaseResult<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> extends MutationState<TData, TError, TVariables, TContext> {
isError: boolean
isIdle: boolean
isLoading: boolean
isSuccess: boolean
mutate: MutateFunction<TData, TError, TVariables, TContext>
reset: () => void
}
export interface MutationObserverIdleResult<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
data: undefined
error: null
isError: false
isIdle: true
isLoading: false
isSuccess: false
status: 'idle'
}
export interface MutationObserverLoadingResult<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
data: undefined
error: null
isError: false
isIdle: false
isLoading: true
isSuccess: false
status: 'loading'
}
export interface MutationObserverErrorResult<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
data: undefined
error: TError
isError: true
isIdle: false
isLoading: false
isSuccess: false
status: 'error'
}
export interface MutationObserverSuccessResult<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
data: TData
error: null
isError: false
isIdle: false
isLoading: false
isSuccess: true
status: 'success'
}
export type MutationObserverResult<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> =
| MutationObserverIdleResult<TData, TError, TVariables, TContext>
| MutationObserverLoadingResult<TData, TError, TVariables, TContext>
| MutationObserverErrorResult<TData, TError, TVariables, TContext>
| MutationObserverSuccessResult<TData, TError, TVariables, TContext>
export interface DefaultOptions<TError = unknown> {
queries?: QueryObserverOptions<unknown, TError>
mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>
}
export interface CancelOptions {
revert?: boolean
silent?: boolean
}
export interface SetDataOptions {
updatedAt?: number
}