@tanstack/react-query 4.36.1 → 4.39.1

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.
Files changed (94) hide show
  1. package/build/lib/__tests__/queryOptions.types.test.d.ts +2 -0
  2. package/build/lib/__tests__/useSuspenseQueries.types.test.d.ts +6 -0
  3. package/build/lib/__tests__/useSuspenseQuery.types.test.d.ts +2 -0
  4. package/build/lib/__tests__/utils.d.ts +1 -0
  5. package/build/lib/index.d.ts +3 -0
  6. package/build/lib/index.esm.js +3 -0
  7. package/build/lib/index.esm.js.map +1 -1
  8. package/build/lib/index.js +6 -0
  9. package/build/lib/index.js.map +1 -1
  10. package/build/lib/index.mjs +3 -0
  11. package/build/lib/index.mjs.map +1 -1
  12. package/build/lib/queryOptions.d.ts +14 -0
  13. package/build/lib/queryOptions.esm.js +6 -0
  14. package/build/lib/queryOptions.esm.js.map +1 -0
  15. package/build/lib/queryOptions.js +10 -0
  16. package/build/lib/queryOptions.js.map +1 -0
  17. package/build/lib/queryOptions.mjs +6 -0
  18. package/build/lib/queryOptions.mjs.map +1 -0
  19. package/build/lib/useQueries.d.ts +22 -11
  20. package/build/lib/useQueries.esm.js.map +1 -1
  21. package/build/lib/useQueries.js.map +1 -1
  22. package/build/lib/useQueries.mjs.map +1 -1
  23. package/build/lib/useQuery.d.ts +21 -14
  24. package/build/lib/useQuery.esm.js +1 -0
  25. package/build/lib/useQuery.esm.js.map +1 -1
  26. package/build/lib/useQuery.js +1 -0
  27. package/build/lib/useQuery.js.map +1 -1
  28. package/build/lib/useQuery.mjs +1 -0
  29. package/build/lib/useQuery.mjs.map +1 -1
  30. package/build/lib/useSuspenseQueries.d.ts +66 -0
  31. package/build/lib/useSuspenseQueries.esm.js +20 -0
  32. package/build/lib/useSuspenseQueries.esm.js.map +1 -0
  33. package/build/lib/useSuspenseQueries.js +24 -0
  34. package/build/lib/useSuspenseQueries.js.map +1 -0
  35. package/build/lib/useSuspenseQueries.mjs +20 -0
  36. package/build/lib/useSuspenseQueries.mjs.map +1 -0
  37. package/build/lib/useSuspenseQuery.d.ts +8 -0
  38. package/build/lib/useSuspenseQuery.esm.js +15 -0
  39. package/build/lib/useSuspenseQuery.esm.js.map +1 -0
  40. package/build/lib/useSuspenseQuery.js +19 -0
  41. package/build/lib/useSuspenseQuery.js.map +1 -0
  42. package/build/lib/useSuspenseQuery.mjs +15 -0
  43. package/build/lib/useSuspenseQuery.mjs.map +1 -0
  44. package/build/umd/index.development.js +90 -2
  45. package/build/umd/index.development.js.map +1 -1
  46. package/build/umd/index.production.js +1 -1
  47. package/build/umd/index.production.js.map +1 -1
  48. package/package.json +3 -10
  49. package/src/__tests__/queryOptions.types.test.tsx +270 -0
  50. package/src/__tests__/useQuery.types.test.tsx +1 -2
  51. package/src/__tests__/useSuspenseQueries.types.test.tsx +102 -0
  52. package/src/__tests__/useSuspenseQuery.types.test.tsx +81 -0
  53. package/src/__tests__/utils.tsx +2 -0
  54. package/src/index.ts +3 -0
  55. package/src/queryOptions.ts +86 -0
  56. package/src/useQueries.ts +50 -22
  57. package/src/useQuery.ts +55 -22
  58. package/src/useSuspenseQueries.ts +162 -0
  59. package/src/useSuspenseQuery.ts +58 -0
  60. package/build/lib/Hydrate.d.ts.map +0 -1
  61. package/build/lib/QueryClientProvider.d.ts.map +0 -1
  62. package/build/lib/QueryErrorResetBoundary.d.ts.map +0 -1
  63. package/build/lib/__tests__/Hydrate.test.d.ts.map +0 -1
  64. package/build/lib/__tests__/QueryClientProvider.test.d.ts.map +0 -1
  65. package/build/lib/__tests__/QueryResetErrorBoundary.test.d.ts.map +0 -1
  66. package/build/lib/__tests__/ssr-hydration.test.d.ts.map +0 -1
  67. package/build/lib/__tests__/ssr.test.d.ts.map +0 -1
  68. package/build/lib/__tests__/suspense.test.d.ts.map +0 -1
  69. package/build/lib/__tests__/useInfiniteQuery.test.d.ts.map +0 -1
  70. package/build/lib/__tests__/useIsFetching.test.d.ts.map +0 -1
  71. package/build/lib/__tests__/useIsMutating.test.d.ts.map +0 -1
  72. package/build/lib/__tests__/useMutation.test.d.ts.map +0 -1
  73. package/build/lib/__tests__/useQueries.test.d.ts.map +0 -1
  74. package/build/lib/__tests__/useQuery.test.d.ts.map +0 -1
  75. package/build/lib/__tests__/useQuery.types.test.d.ts.map +0 -1
  76. package/build/lib/__tests__/utils.d.ts.map +0 -1
  77. package/build/lib/errorBoundaryUtils.d.ts.map +0 -1
  78. package/build/lib/index.d.ts.map +0 -1
  79. package/build/lib/isRestoring.d.ts.map +0 -1
  80. package/build/lib/reactBatchedUpdates.d.ts.map +0 -1
  81. package/build/lib/reactBatchedUpdates.native.d.ts.map +0 -1
  82. package/build/lib/setBatchUpdatesFn.d.ts.map +0 -1
  83. package/build/lib/suspense.d.ts.map +0 -1
  84. package/build/lib/types.d.ts.map +0 -1
  85. package/build/lib/useBaseQuery.d.ts.map +0 -1
  86. package/build/lib/useInfiniteQuery.d.ts.map +0 -1
  87. package/build/lib/useIsFetching.d.ts.map +0 -1
  88. package/build/lib/useIsMutating.d.ts.map +0 -1
  89. package/build/lib/useMutation.d.ts.map +0 -1
  90. package/build/lib/useQueries.d.ts.map +0 -1
  91. package/build/lib/useQuery.d.ts.map +0 -1
  92. package/build/lib/useSyncExternalStore.d.ts.map +0 -1
  93. package/build/lib/useSyncExternalStore.native.d.ts.map +0 -1
  94. package/build/lib/utils.d.ts.map +0 -1
package/build/lib/useSuspenseQueries.d.ts ADDED
@@ -0,0 +1,66 @@
1
+ import type { UseQueryOptions } from './types';
2
+ import type { QueryFunction } from '@tanstack/query-core';
3
+ import type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery';
4
+ declare type MAXIMUM_DEPTH = 20;
5
+ declare type GetSuspenseOptions<T> = T extends {
6
+ queryFnData: infer TQueryFnData;
7
+ error?: infer TError;
8
+ data: infer TData;
9
+ } ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends {
10
+ queryFnData: infer TQueryFnData;
11
+ error?: infer TError;
12
+ } ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends {
13
+ data: infer TData;
14
+ error?: infer TError;
15
+ } ? UseSuspenseQueryOptions<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseSuspenseQueryOptions<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryOptions<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryOptions<TQueryFnData> : T extends {
16
+ queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
17
+ select?: (data: any) => infer TData;
18
+ } ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey> : T extends {
19
+ queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
20
+ } ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey> : UseSuspenseQueryOptions;
21
+ declare type GetSuspenseResults<T> = T extends {
22
+ queryFnData: any;
23
+ error?: infer TError;
24
+ data: infer TData;
25
+ } ? UseSuspenseQueryResult<TData, TError> : T extends {
26
+ queryFnData: infer TQueryFnData;
27
+ error?: infer TError;
28
+ } ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends {
29
+ data: infer TData;
30
+ error?: infer TError;
31
+ } ? UseSuspenseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseSuspenseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseSuspenseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseSuspenseQueryResult<TQueryFnData> : T extends {
32
+ queryFn?: QueryFunction<infer TQueryFnData, any>;
33
+ select?: (data: any) => infer TData;
34
+ } ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData> : T extends {
35
+ queryFn?: QueryFunction<infer TQueryFnData, any>;
36
+ } ? UseSuspenseQueryResult<TQueryFnData> : UseSuspenseQueryResult;
37
+ /**
38
+ * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
39
+ */
40
+ export declare type SuspenseQueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryOptions> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetSuspenseOptions<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesOptions<[
41
+ ...Tail
42
+ ], [
43
+ ...TResult,
44
+ GetSuspenseOptions<Head>
45
+ ], [
46
+ ...TDepth,
47
+ 1
48
+ ]> : Array<unknown> extends T ? T : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>> : Array<UseSuspenseQueryOptions>;
49
+ /**
50
+ * SuspenseQueriesResults reducer recursively maps type param to results
51
+ */
52
+ export declare type SuspenseQueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseSuspenseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetSuspenseResults<Head>] : T extends [infer Head, ...infer Tail] ? SuspenseQueriesResults<[
53
+ ...Tail
54
+ ], [
55
+ ...TResult,
56
+ GetSuspenseResults<Head>
57
+ ], [
58
+ ...TDepth,
59
+ 1
60
+ ]> : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>> ? Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>> : Array<UseSuspenseQueryResult>;
61
+ export declare function useSuspenseQueries<T extends any[]>({ queries, context, }: {
62
+ queries: readonly [...SuspenseQueriesOptions<T>];
63
+ context?: UseQueryOptions['context'];
64
+ }): SuspenseQueriesResults<T>;
65
+ export {};
66
+ //# sourceMappingURL=useSuspenseQueries.d.ts.map
package/build/lib/useSuspenseQueries.esm.js ADDED
@@ -0,0 +1,20 @@
1
+ import { useQueries } from './useQueries.esm.js';
2
+
3
+ function useSuspenseQueries({
4
+ queries,
5
+ context
6
+ }) {
7
+ return useQueries({
8
+ queries: queries.map(query => ({ ...query,
9
+ enabled: true,
10
+ useErrorBoundary: true,
11
+ suspense: true,
12
+ placeholderData: undefined,
13
+ networkMode: 'always'
14
+ })),
15
+ context
16
+ });
17
+ }
18
+
19
+ export { useSuspenseQueries };
20
+ //# sourceMappingURL=useSuspenseQueries.esm.js.map
package/build/lib/useSuspenseQueries.esm.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useSuspenseQueries.esm.js","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type { UseQueryOptions } from './types'\nimport type { NetworkMode, QueryFunction } from '@tanstack/query-core'\nimport type {\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from './useSuspenseQuery'\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetSuspenseOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryOptions<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryOptions<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>\n : // Fallback\n UseSuspenseQueryOptions\n\ntype GetSuspenseResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? UseSuspenseQueryResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? UseSuspenseQueryResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n }\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Fallback\n UseSuspenseQueryResult\n\n/**\n * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type SuspenseQueriesOptions<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryOptions>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesOptions<\n [...Tail],\n [...TResult, GetSuspenseOptions<Head>],\n [...TDepth, 1]\n >\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseSuspenseQueryOptions>\n\n/**\n * SuspenseQueriesResults reducer recursively maps type param to results\n */\nexport type SuspenseQueriesResults<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesResults<\n [...Tail],\n [...TResult, GetSuspenseResults<Head>],\n [...TDepth, 1]\n >\n : T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any\n >\n >\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<\n UseSuspenseQueryResult<\n unknown extends TData ? TQueryFnData : TData,\n TError\n >\n >\n : // Fallback\n Array<UseSuspenseQueryResult>\n\nexport function useSuspenseQueries<T extends any[]>({\n queries,\n context,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n context?: UseQueryOptions['context']\n}): SuspenseQueriesResults<T> {\n return useQueries({\n queries: queries.map((query) => ({\n ...query,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n placeholderData: undefined,\n networkMode: 'always' as NetworkMode,\n })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n"],"names":["useSuspenseQueries","queries","context","useQueries","map","query","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode"],"mappings":";;AA+IO,SAASA,kBAAT,CAA6C;EAClDC,OADkD;AAElDC,EAAAA,OAAAA;AAFkD,CAA7C,EAMuB;AAC5B,EAAA,OAAOC,UAAU,CAAC;IAChBF,OAAO,EAAEA,OAAO,CAACG,GAAR,CAAaC,KAAD,KAAY,EAC/B,GAAGA,KAD4B;AAE/BC,MAAAA,OAAO,EAAE,IAFsB;AAG/BC,MAAAA,gBAAgB,EAAE,IAHa;AAI/BC,MAAAA,QAAQ,EAAE,IAJqB;AAK/BC,MAAAA,eAAe,EAAEC,SALc;AAM/BC,MAAAA,WAAW,EAAE,QAAA;AANkB,KAAZ,CAAZ,CADO;AAShBT,IAAAA,OAAAA;AATgB,GAAD,CAAjB,CAAA;AAWD;;;;"}
package/build/lib/useSuspenseQueries.js ADDED
@@ -0,0 +1,24 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var useQueries = require('./useQueries.js');
6
+
7
+ function useSuspenseQueries({
8
+ queries,
9
+ context
10
+ }) {
11
+ return useQueries.useQueries({
12
+ queries: queries.map(query => ({ ...query,
13
+ enabled: true,
14
+ useErrorBoundary: true,
15
+ suspense: true,
16
+ placeholderData: undefined,
17
+ networkMode: 'always'
18
+ })),
19
+ context
20
+ });
21
+ }
22
+
23
+ exports.useSuspenseQueries = useSuspenseQueries;
24
+ //# sourceMappingURL=useSuspenseQueries.js.map
package/build/lib/useSuspenseQueries.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useSuspenseQueries.js","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type { UseQueryOptions } from './types'\nimport type { NetworkMode, QueryFunction } from '@tanstack/query-core'\nimport type {\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from './useSuspenseQuery'\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetSuspenseOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryOptions<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryOptions<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>\n : // Fallback\n UseSuspenseQueryOptions\n\ntype GetSuspenseResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? UseSuspenseQueryResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? UseSuspenseQueryResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n }\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Fallback\n UseSuspenseQueryResult\n\n/**\n * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type SuspenseQueriesOptions<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryOptions>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesOptions<\n [...Tail],\n [...TResult, GetSuspenseOptions<Head>],\n [...TDepth, 1]\n >\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseSuspenseQueryOptions>\n\n/**\n * SuspenseQueriesResults reducer recursively maps type param to results\n */\nexport type SuspenseQueriesResults<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesResults<\n [...Tail],\n [...TResult, GetSuspenseResults<Head>],\n [...TDepth, 1]\n >\n : T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any\n >\n >\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<\n UseSuspenseQueryResult<\n unknown extends TData ? TQueryFnData : TData,\n TError\n >\n >\n : // Fallback\n Array<UseSuspenseQueryResult>\n\nexport function useSuspenseQueries<T extends any[]>({\n queries,\n context,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n context?: UseQueryOptions['context']\n}): SuspenseQueriesResults<T> {\n return useQueries({\n queries: queries.map((query) => ({\n ...query,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n placeholderData: undefined,\n networkMode: 'always' as NetworkMode,\n })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n"],"names":["useSuspenseQueries","queries","context","useQueries","map","query","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode"],"mappings":";;;;;;AA+IO,SAASA,kBAAT,CAA6C;EAClDC,OADkD;AAElDC,EAAAA,OAAAA;AAFkD,CAA7C,EAMuB;AAC5B,EAAA,OAAOC,qBAAU,CAAC;IAChBF,OAAO,EAAEA,OAAO,CAACG,GAAR,CAAaC,KAAD,KAAY,EAC/B,GAAGA,KAD4B;AAE/BC,MAAAA,OAAO,EAAE,IAFsB;AAG/BC,MAAAA,gBAAgB,EAAE,IAHa;AAI/BC,MAAAA,QAAQ,EAAE,IAJqB;AAK/BC,MAAAA,eAAe,EAAEC,SALc;AAM/BC,MAAAA,WAAW,EAAE,QAAA;AANkB,KAAZ,CAAZ,CADO;AAShBT,IAAAA,OAAAA;AATgB,GAAD,CAAjB,CAAA;AAWD;;;;"}
package/build/lib/useSuspenseQueries.mjs ADDED
@@ -0,0 +1,20 @@
1
+ import { useQueries } from './useQueries.mjs';
2
+
3
+ function useSuspenseQueries({
4
+ queries,
5
+ context
6
+ }) {
7
+ return useQueries({
8
+ queries: queries.map(query => ({ ...query,
9
+ enabled: true,
10
+ useErrorBoundary: true,
11
+ suspense: true,
12
+ placeholderData: undefined,
13
+ networkMode: 'always'
14
+ })),
15
+ context
16
+ });
17
+ }
18
+
19
+ export { useSuspenseQueries };
20
+ //# sourceMappingURL=useSuspenseQueries.mjs.map
package/build/lib/useSuspenseQueries.mjs.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useSuspenseQueries.mjs","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type { UseQueryOptions } from './types'\nimport type { NetworkMode, QueryFunction } from '@tanstack/query-core'\nimport type {\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from './useSuspenseQuery'\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetSuspenseOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryOptions<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryOptions<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>\n : // Fallback\n UseSuspenseQueryOptions\n\ntype GetSuspenseResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? UseSuspenseQueryResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? UseSuspenseQueryResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n }\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Fallback\n UseSuspenseQueryResult\n\n/**\n * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type SuspenseQueriesOptions<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryOptions>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesOptions<\n [...Tail],\n [...TResult, GetSuspenseOptions<Head>],\n [...TDepth, 1]\n >\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseSuspenseQueryOptions>\n\n/**\n * SuspenseQueriesResults reducer recursively maps type param to results\n */\nexport type SuspenseQueriesResults<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesResults<\n [...Tail],\n [...TResult, GetSuspenseResults<Head>],\n [...TDepth, 1]\n >\n : T extends Array<\n UseSuspenseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any\n >\n >\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<\n UseSuspenseQueryResult<\n unknown extends TData ? TQueryFnData : TData,\n TError\n >\n >\n : // Fallback\n Array<UseSuspenseQueryResult>\n\nexport function useSuspenseQueries<T extends any[]>({\n queries,\n context,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n context?: UseQueryOptions['context']\n}): SuspenseQueriesResults<T> {\n return useQueries({\n queries: queries.map((query) => ({\n ...query,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n placeholderData: undefined,\n networkMode: 'always' as NetworkMode,\n })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n"],"names":["useSuspenseQueries","queries","context","useQueries","map","query","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode"],"mappings":";;AA+IO,SAASA,kBAAT,CAA6C;EAClDC,OADkD;AAElDC,EAAAA,OAAAA;AAFkD,CAA7C,EAMuB;AAC5B,EAAA,OAAOC,UAAU,CAAC;IAChBF,OAAO,EAAEA,OAAO,CAACG,GAAR,CAAaC,KAAD,KAAY,EAC/B,GAAGA,KAD4B;AAE/BC,MAAAA,OAAO,EAAE,IAFsB;AAG/BC,MAAAA,gBAAgB,EAAE,IAHa;AAI/BC,MAAAA,QAAQ,EAAE,IAJqB;AAK/BC,MAAAA,eAAe,EAAEC,SALc;AAM/BC,MAAAA,WAAW,EAAE,QAAA;AANkB,KAAZ,CAAZ,CADO;AAShBT,IAAAA,OAAAA;AATgB,GAAD,CAAjB,CAAA;AAWD;;;;"}
package/build/lib/useSuspenseQuery.d.ts ADDED
@@ -0,0 +1,8 @@
1
+ import type { DefinedQueryObserverResult, OmitKeyof, QueryKey } from '@tanstack/query-core';
2
+ import type { UseQueryOptions } from './types';
3
+ declare type DistributiveOmit<TObject, TKey extends keyof TObject> = TObject extends any ? Omit<TObject, TKey> : never;
4
+ export declare type UseSuspenseQueryResult<TData = unknown, TError = unknown> = DistributiveOmit<DefinedQueryObserverResult<TData, TError>, 'isPlaceholderData'>;
5
+ export declare type UseSuspenseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'enabled' | 'useErrorBoundary' | 'suspense' | 'placeholderData' | 'networkMode' | 'onSuccess' | 'onError' | 'onSettled' | 'getPreviousPageParam' | 'getNextPageParam'>;
6
+ export declare function useSuspenseQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseSuspenseQueryResult<TData, TError>;
7
+ export {};
8
+ //# sourceMappingURL=useSuspenseQuery.d.ts.map
package/build/lib/useSuspenseQuery.esm.js ADDED
@@ -0,0 +1,15 @@
1
+ import { QueryObserver } from '@tanstack/query-core';
2
+ import { useBaseQuery } from './useBaseQuery.esm.js';
3
+
4
+ function useSuspenseQuery(options) {
5
+ return useBaseQuery({ ...options,
6
+ enabled: true,
7
+ useErrorBoundary: true,
8
+ suspense: true,
9
+ placeholderData: undefined,
10
+ networkMode: 'always'
11
+ }, QueryObserver);
12
+ }
13
+
14
+ export { useSuspenseQuery };
15
+ //# sourceMappingURL=useSuspenseQuery.esm.js.map
package/build/lib/useSuspenseQuery.esm.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useSuspenseQuery.esm.js","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n DefinedQueryObserverResult,\n OmitKeyof,\n QueryKey,\n} from '@tanstack/query-core'\nimport type { UseQueryOptions } from './types'\n\ntype DistributiveOmit<TObject, TKey extends keyof TObject> = TObject extends any\n ? Omit<TObject, TKey>\n : never\n\nexport type UseSuspenseQueryResult<\n TData = unknown,\n TError = unknown,\n> = DistributiveOmit<\n DefinedQueryObserverResult<TData, TError>,\n 'isPlaceholderData'\n>\n\nexport type UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'enabled'\n | 'useErrorBoundary'\n | 'suspense'\n | 'placeholderData'\n | 'networkMode'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'getPreviousPageParam'\n | 'getNextPageParam'\n>\n\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n return useBaseQuery(\n {\n ...options,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n placeholderData: undefined,\n networkMode: 'always',\n },\n QueryObserver,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"names":["useSuspenseQuery","options","useBaseQuery","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode","QueryObserver"],"mappings":";;;AAwCO,SAASA,gBAAT,CAKLC,OALK,EAKqE;AAC1E,EAAA,OAAOC,YAAY,CACjB,EACE,GAAGD,OADL;AAEEE,IAAAA,OAAO,EAAE,IAFX;AAGEC,IAAAA,gBAAgB,EAAE,IAHpB;AAIEC,IAAAA,QAAQ,EAAE,IAJZ;AAKEC,IAAAA,eAAe,EAAEC,SALnB;AAMEC,IAAAA,WAAW,EAAE,QAAA;GAPE,EASjBC,aATiB,CAAnB,CAAA;AAWD;;;;"}
package/build/lib/useSuspenseQuery.js ADDED
@@ -0,0 +1,19 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var queryCore = require('@tanstack/query-core');
6
+ var useBaseQuery = require('./useBaseQuery.js');
7
+
8
+ function useSuspenseQuery(options) {
9
+ return useBaseQuery.useBaseQuery({ ...options,
10
+ enabled: true,
11
+ useErrorBoundary: true,
12
+ suspense: true,
13
+ placeholderData: undefined,
14
+ networkMode: 'always'
15
+ }, queryCore.QueryObserver);
16
+ }
17
+
18
+ exports.useSuspenseQuery = useSuspenseQuery;
19
+ //# sourceMappingURL=useSuspenseQuery.js.map
package/build/lib/useSuspenseQuery.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useSuspenseQuery.js","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n DefinedQueryObserverResult,\n OmitKeyof,\n QueryKey,\n} from '@tanstack/query-core'\nimport type { UseQueryOptions } from './types'\n\ntype DistributiveOmit<TObject, TKey extends keyof TObject> = TObject extends any\n ? Omit<TObject, TKey>\n : never\n\nexport type UseSuspenseQueryResult<\n TData = unknown,\n TError = unknown,\n> = DistributiveOmit<\n DefinedQueryObserverResult<TData, TError>,\n 'isPlaceholderData'\n>\n\nexport type UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'enabled'\n | 'useErrorBoundary'\n | 'suspense'\n | 'placeholderData'\n | 'networkMode'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'getPreviousPageParam'\n | 'getNextPageParam'\n>\n\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n return useBaseQuery(\n {\n ...options,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n placeholderData: undefined,\n networkMode: 'always',\n },\n QueryObserver,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"names":["useSuspenseQuery","options","useBaseQuery","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode","QueryObserver"],"mappings":";;;;;;;AAwCO,SAASA,gBAAT,CAKLC,OALK,EAKqE;AAC1E,EAAA,OAAOC,yBAAY,CACjB,EACE,GAAGD,OADL;AAEEE,IAAAA,OAAO,EAAE,IAFX;AAGEC,IAAAA,gBAAgB,EAAE,IAHpB;AAIEC,IAAAA,QAAQ,EAAE,IAJZ;AAKEC,IAAAA,eAAe,EAAEC,SALnB;AAMEC,IAAAA,WAAW,EAAE,QAAA;GAPE,EASjBC,uBATiB,CAAnB,CAAA;AAWD;;;;"}
package/build/lib/useSuspenseQuery.mjs ADDED
@@ -0,0 +1,15 @@
1
+ import { QueryObserver } from '@tanstack/query-core';
2
+ import { useBaseQuery } from './useBaseQuery.mjs';
3
+
4
+ function useSuspenseQuery(options) {
5
+ return useBaseQuery({ ...options,
6
+ enabled: true,
7
+ useErrorBoundary: true,
8
+ suspense: true,
9
+ placeholderData: undefined,
10
+ networkMode: 'always'
11
+ }, QueryObserver);
12
+ }
13
+
14
+ export { useSuspenseQuery };
15
+ //# sourceMappingURL=useSuspenseQuery.mjs.map
package/build/lib/useSuspenseQuery.mjs.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useSuspenseQuery.mjs","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n DefinedQueryObserverResult,\n OmitKeyof,\n QueryKey,\n} from '@tanstack/query-core'\nimport type { UseQueryOptions } from './types'\n\ntype DistributiveOmit<TObject, TKey extends keyof TObject> = TObject extends any\n ? Omit<TObject, TKey>\n : never\n\nexport type UseSuspenseQueryResult<\n TData = unknown,\n TError = unknown,\n> = DistributiveOmit<\n DefinedQueryObserverResult<TData, TError>,\n 'isPlaceholderData'\n>\n\nexport type UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'enabled'\n | 'useErrorBoundary'\n | 'suspense'\n | 'placeholderData'\n | 'networkMode'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'getPreviousPageParam'\n | 'getNextPageParam'\n>\n\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n return useBaseQuery(\n {\n ...options,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n placeholderData: undefined,\n networkMode: 'always',\n },\n QueryObserver,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"names":["useSuspenseQuery","options","useBaseQuery","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode","QueryObserver"],"mappings":";;;AAwCO,SAASA,gBAAT,CAKLC,OALK,EAKqE;AAC1E,EAAA,OAAOC,YAAY,CACjB,EACE,GAAGD,OADL;AAEEE,IAAAA,OAAO,EAAE,IAFX;AAGEC,IAAAA,gBAAgB,EAAE,IAHpB;AAIEC,IAAAA,QAAQ,EAAE,IAJZ;AAKEC,IAAAA,eAAe,EAAEC,SALnB;AAMEC,IAAAA,WAAW,EAAE,QAAA;GAPE,EASjBC,aATiB,CAAnB,CAAA;AAWD;;;;"}
package/build/umd/index.development.js CHANGED
@@ -1381,6 +1381,9 @@
1381
1381
  return this.queries;
1382
1382
  }
1383
1383
 
1384
+ /**
1385
+ * @deprecated This method should be used with only one object argument.
1386
+ */
1384
1387
  find(arg1, arg2) {
1385
1388
  const [filters] = parseFilterArgs(arg1, arg2);
1386
1389
 
@@ -1391,6 +1394,9 @@
1391
1394
  return this.queries.find(query => matchQuery(filters, query));
1392
1395
  }
1393
1396
 
1397
+ /**
1398
+ * @deprecated This method should be used with only one object argument.
1399
+ */
1394
1400
  findAll(arg1, arg2) {
1395
1401
  const [filters] = parseFilterArgs(arg1, arg2);
1396
1402
  return Object.keys(filters).length > 0 ? this.queries.filter(query => matchQuery(filters, query)) : this.queries;
@@ -1952,6 +1958,9 @@
1952
1958
  this.unsubscribeOnline = undefined;
1953
1959
  }
1954
1960
 
1961
+ /**
1962
+ * @deprecated This method should be used with only one object argument.
1963
+ */
1955
1964
  isFetching(arg1, arg2) {
1956
1965
  const [filters] = parseFilterArgs(arg1, arg2);
1957
1966
  filters.fetchStatus = 'fetching';
@@ -1964,18 +1973,27 @@
1964
1973
  }).length;
1965
1974
  }
1966
1975
 
1976
+ /**
1977
+ * @deprecated This method will accept only queryKey in the next major version.
1978
+ */
1967
1979
  getQueryData(queryKey, filters) {
1968
1980
  var _this$queryCache$find;
1969
1981
 
1970
1982
  return (_this$queryCache$find = this.queryCache.find(queryKey, filters)) == null ? void 0 : _this$queryCache$find.state.data;
1971
1983
  }
1972
1984
 
1985
+ /**
1986
+ * @deprecated This method should be used with only one object argument.
1987
+ */
1973
1988
  ensureQueryData(arg1, arg2, arg3) {
1974
1989
  const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
1975
1990
  const cachedData = this.getQueryData(parsedOptions.queryKey);
1976
1991
  return cachedData ? Promise.resolve(cachedData) : this.fetchQuery(parsedOptions);
1977
1992
  }
1978
1993
 
1994
+ /**
1995
+ * @deprecated This method should be used with only one object argument.
1996
+ */
1979
1997
  getQueriesData(queryKeyOrFilters) {
1980
1998
  return this.getQueryCache().findAll(queryKeyOrFilters).map(({
1981
1999
  queryKey,
@@ -2002,18 +2020,28 @@
2002
2020
  });
2003
2021
  }
2004
2022
 
2023
+ /**
2024
+ * @deprecated This method should be used with only one object argument.
2025
+ */
2005
2026
  setQueriesData(queryKeyOrFilters, updater, options) {
2006
2027
  return notifyManager.batch(() => this.getQueryCache().findAll(queryKeyOrFilters).map(({
2007
2028
  queryKey
2008
2029
  }) => [queryKey, this.setQueryData(queryKey, updater, options)]));
2009
2030
  }
2010
2031
 
2011
- getQueryState(queryKey, filters) {
2032
+ getQueryState(queryKey,
2033
+ /**
2034
+ * @deprecated This filters will be removed in the next major version.
2035
+ */
2036
+ filters) {
2012
2037
  var _this$queryCache$find2;
2013
2038
 
2014
2039
  return (_this$queryCache$find2 = this.queryCache.find(queryKey, filters)) == null ? void 0 : _this$queryCache$find2.state;
2015
2040
  }
2016
2041
 
2042
+ /**
2043
+ * @deprecated This method should be used with only one object argument.
2044
+ */
2017
2045
  removeQueries(arg1, arg2) {
2018
2046
  const [filters] = parseFilterArgs(arg1, arg2);
2019
2047
  const queryCache = this.queryCache;
@@ -2024,6 +2052,9 @@
2024
2052
  });
2025
2053
  }
2026
2054
 
2055
+ /**
2056
+ * @deprecated This method should be used with only one object argument.
2057
+ */
2027
2058
  resetQueries(arg1, arg2, arg3) {
2028
2059
  const [filters, options] = parseFilterArgs(arg1, arg2, arg3);
2029
2060
  const queryCache = this.queryCache;
@@ -2039,6 +2070,9 @@
2039
2070
  });
2040
2071
  }
2041
2072
 
2073
+ /**
2074
+ * @deprecated This method should be used with only one object argument.
2075
+ */
2042
2076
  cancelQueries(arg1, arg2, arg3) {
2043
2077
  const [filters, cancelOptions = {}] = parseFilterArgs(arg1, arg2, arg3);
2044
2078
 
@@ -2050,6 +2084,9 @@
2050
2084
  return Promise.all(promises).then(noop$1).catch(noop$1);
2051
2085
  }
2052
2086
 
2087
+ /**
2088
+ * @deprecated This method should be used with only one object argument.
2089
+ */
2053
2090
  invalidateQueries(arg1, arg2, arg3) {
2054
2091
  const [filters, options] = parseFilterArgs(arg1, arg2, arg3);
2055
2092
  return notifyManager.batch(() => {
@@ -2070,6 +2107,9 @@
2070
2107
  });
2071
2108
  }
2072
2109
 
2110
+ /**
2111
+ * @deprecated This method should be used with only one object argument.
2112
+ */
2073
2113
  refetchQueries(arg1, arg2, arg3) {
2074
2114
  const [filters, options] = parseFilterArgs(arg1, arg2, arg3);
2075
2115
  const promises = notifyManager.batch(() => this.queryCache.findAll(filters).filter(query => !query.isDisabled()).map(query => {
@@ -2091,6 +2131,9 @@
2091
2131
  return promise;
2092
2132
  }
2093
2133
 
2134
+ /**
2135
+ * @deprecated This method should be used with only one object argument.
2136
+ */
2094
2137
  fetchQuery(arg1, arg2, arg3) {
2095
2138
  const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
2096
2139
  const defaultedOptions = this.defaultQueryOptions(parsedOptions); // https://github.com/tannerlinsley/react-query/issues/652
@@ -2103,16 +2146,25 @@
2103
2146
  return query.isStaleByTime(defaultedOptions.staleTime) ? query.fetch(defaultedOptions) : Promise.resolve(query.state.data);
2104
2147
  }
2105
2148
 
2149
+ /**
2150
+ * @deprecated This method should be used with only one object argument.
2151
+ */
2106
2152
  prefetchQuery(arg1, arg2, arg3) {
2107
2153
  return this.fetchQuery(arg1, arg2, arg3).then(noop$1).catch(noop$1);
2108
2154
  }
2109
2155
 
2156
+ /**
2157
+ * @deprecated This method should be used with only one object argument.
2158
+ */
2110
2159
  fetchInfiniteQuery(arg1, arg2, arg3) {
2111
2160
  const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
2112
2161
  parsedOptions.behavior = infiniteQueryBehavior();
2113
2162
  return this.fetchQuery(parsedOptions);
2114
2163
  }
2115
2164
 
2165
+ /**
2166
+ * @deprecated This method should be used with only one object argument.
2167
+ */
2116
2168
  prefetchInfiniteQuery(arg1, arg2, arg3) {
2117
2169
  return this.fetchInfiniteQuery(arg1, arg2, arg3).then(noop$1).catch(noop$1);
2118
2170
  }
@@ -3150,8 +3202,10 @@
3150
3202
 
3151
3203
  updateResult() {
3152
3204
  const state = this.currentMutation ? this.currentMutation.state : getDefaultState();
3205
+ const isLoading = state.status === 'loading';
3153
3206
  const result = { ...state,
3154
- isLoading: state.status === 'loading',
3207
+ isLoading,
3208
+ isPending: isLoading,
3155
3209
  isSuccess: state.status === 'success',
3156
3210
  isError: state.status === 'error',
3157
3211
  isIdle: state.status === 'idle',
@@ -3834,11 +3888,38 @@
3834
3888
  return !defaultedOptions.notifyOnChangeProps ? observer.trackResult(result) : result;
3835
3889
  }
3836
3890
 
3891
+ /** @deprecated */
3837
3892
  function useQuery(arg1, arg2, arg3) {
3838
3893
  const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
3839
3894
  return useBaseQuery(parsedOptions, QueryObserver);
3840
3895
  }
3841
3896
 
3897
+ function useSuspenseQuery(options) {
3898
+ return useBaseQuery({ ...options,
3899
+ enabled: true,
3900
+ useErrorBoundary: true,
3901
+ suspense: true,
3902
+ placeholderData: undefined,
3903
+ networkMode: 'always'
3904
+ }, QueryObserver);
3905
+ }
3906
+
3907
+ function useSuspenseQueries({
3908
+ queries,
3909
+ context
3910
+ }) {
3911
+ return useQueries({
3912
+ queries: queries.map(query => ({ ...query,
3913
+ enabled: true,
3914
+ useErrorBoundary: true,
3915
+ suspense: true,
3916
+ placeholderData: undefined,
3917
+ networkMode: 'always'
3918
+ })),
3919
+ context
3920
+ });
3921
+ }
3922
+
3842
3923
  function useHydrate(state, options = {}) {
3843
3924
  const queryClient = useQueryClient({
3844
3925
  context: options.context
@@ -3913,6 +3994,10 @@
3913
3994
  return useBaseQuery(options, InfiniteQueryObserver);
3914
3995
  }
3915
3996
 
3997
+ function queryOptions(options) {
3998
+ return options;
3999
+ }
4000
+
3916
4001
  exports.CancelledError = CancelledError;
3917
4002
  exports.Hydrate = Hydrate;
3918
4003
  exports.InfiniteQueryObserver = InfiniteQueryObserver;
@@ -3943,6 +4028,7 @@
3943
4028
  exports.parseMutationArgs = parseMutationArgs;
3944
4029
  exports.parseMutationFilterArgs = parseMutationFilterArgs;
3945
4030
  exports.parseQueryArgs = parseQueryArgs;
4031
+ exports.queryOptions = queryOptions;
3946
4032
  exports.replaceEqualDeep = replaceEqualDeep;
3947
4033
  exports.useHydrate = useHydrate;
3948
4034
  exports.useInfiniteQuery = useInfiniteQuery;
@@ -3954,6 +4040,8 @@
3954
4040
  exports.useQuery = useQuery;
3955
4041
  exports.useQueryClient = useQueryClient;
3956
4042
  exports.useQueryErrorResetBoundary = useQueryErrorResetBoundary;
4043
+ exports.useSuspenseQueries = useSuspenseQueries;
4044
+ exports.useSuspenseQuery = useSuspenseQuery;
3957
4045
 
3958
4046
  Object.defineProperty(exports, '__esModule', { value: true });
3959
4047