@tanstack/query-core 4.39.1 → 4.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,6 +6,7 @@ import type { QueryCache } from './queryCache';
6
6
  import type { MutationCache } from './mutationCache';
7
7
  import type { Logger } from './logger';
8
8
  export declare type NonUndefinedGuard<T> = T extends undefined ? never : T;
9
+ export declare type DistributiveOmit<TObject, TKey extends keyof TObject> = TObject extends any ? Omit<TObject, TKey> : never;
9
10
  export declare type OmitKeyof<TObject, TKey extends TStrictly extends 'safely' ? keyof TObject | (string & Record<never, never>) | (number & Record<never, never>) | (symbol & Record<never, never>) : keyof TObject, TStrictly extends 'strictly' | 'safely' = 'strictly'> = Omit<TObject, TKey>;
10
11
  export declare type QueryKey = readonly unknown[];
11
12
  export declare type QueryFunction<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = any> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>;
@@ -384,6 +385,9 @@ export declare type MutateFunction<TData = unknown, TError = unknown, TVariables
384
385
  export interface MutationObserverBaseResult<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends MutationState<TData, TError, TVariables, TContext> {
385
386
  isError: boolean;
386
387
  isIdle: boolean;
388
+ /**
389
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
390
+ */
387
391
  isLoading: boolean;
388
392
  isPending: boolean;
389
393
  isSuccess: boolean;
@@ -395,7 +399,11 @@ export interface MutationObserverIdleResult<TData = unknown, TError = unknown, T
395
399
  error: null;
396
400
  isError: false;
397
401
  isIdle: true;
402
+ /**
403
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
404
+ */
398
405
  isLoading: false;
406
+ isPending: false;
399
407
  isSuccess: false;
400
408
  status: 'idle';
401
409
  }
@@ -404,7 +412,11 @@ export interface MutationObserverLoadingResult<TData = unknown, TError = unknown
404
412
  error: null;
405
413
  isError: false;
406
414
  isIdle: false;
415
+ /**
416
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
417
+ */
407
418
  isLoading: true;
419
+ isPending: true;
408
420
  isSuccess: false;
409
421
  status: 'loading';
410
422
  }
@@ -413,7 +425,11 @@ export interface MutationObserverErrorResult<TData = unknown, TError = unknown,
413
425
  error: TError;
414
426
  isError: true;
415
427
  isIdle: false;
428
+ /**
429
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
430
+ */
416
431
  isLoading: false;
432
+ isPending: false;
417
433
  isSuccess: false;
418
434
  status: 'error';
419
435
  }
@@ -422,7 +438,11 @@ export interface MutationObserverSuccessResult<TData = unknown, TError = unknown
422
438
  error: null;
423
439
  isError: false;
424
440
  isIdle: false;
441
+ /**
442
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
443
+ */
425
444
  isLoading: false;
445
+ isPending: false;
426
446
  isSuccess: true;
427
447
  status: 'success';
428
448
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/query-core",
3
- "version": "4.39.1",
3
+ "version": "4.40.0",
4
4
  "description": "The framework agnostic core that powers TanStack Query",
5
5
  "author": "tannerlinsley",
6
6
  "license": "MIT",
package/src/types.ts CHANGED
@@ -10,6 +10,11 @@ import type { Logger } from './logger'
10
10
 
11
11
  export type NonUndefinedGuard<T> = T extends undefined ? never : T
12
12
 
13
+ export type DistributiveOmit<
14
+ TObject,
15
+ TKey extends keyof TObject,
16
+ > = TObject extends any ? Omit<TObject, TKey> : never
17
+
13
18
  export type OmitKeyof<
14
19
  TObject,
15
20
  TKey extends TStrictly extends 'safely'
@@ -664,6 +669,9 @@ export interface MutationObserverBaseResult<
664
669
  > extends MutationState<TData, TError, TVariables, TContext> {
665
670
  isError: boolean
666
671
  isIdle: boolean
672
+ /**
673
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
674
+ */
667
675
  isLoading: boolean
668
676
  isPending: boolean
669
677
  isSuccess: boolean
@@ -681,7 +689,11 @@ export interface MutationObserverIdleResult<
681
689
  error: null
682
690
  isError: false
683
691
  isIdle: true
692
+ /**
693
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
694
+ */
684
695
  isLoading: false
696
+ isPending: false
685
697
  isSuccess: false
686
698
  status: 'idle'
687
699
  }
@@ -696,7 +708,11 @@ export interface MutationObserverLoadingResult<
696
708
  error: null
697
709
  isError: false
698
710
  isIdle: false
711
+ /**
712
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
713
+ */
699
714
  isLoading: true
715
+ isPending: true
700
716
  isSuccess: false
701
717
  status: 'loading'
702
718
  }
@@ -711,7 +727,11 @@ export interface MutationObserverErrorResult<
711
727
  error: TError
712
728
  isError: true
713
729
  isIdle: false
730
+ /**
731
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
732
+ */
714
733
  isLoading: false
734
+ isPending: false
715
735
  isSuccess: false
716
736
  status: 'error'
717
737
  }
@@ -726,7 +746,11 @@ export interface MutationObserverSuccessResult<
726
746
  error: null
727
747
  isError: false
728
748
  isIdle: false
749
+ /**
750
+ * @deprecated This property will be removed in the next major version. Use `isPending` instead.
751
+ */
729
752
  isLoading: false
753
+ isPending: false
730
754
  isSuccess: true
731
755
  status: 'success'
732
756
  }