@tanstack/react-query 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.
- package/build/lib/index.d.ts +3 -1
- package/build/lib/index.esm.js +1 -1
- package/build/lib/index.js +2 -2
- package/build/lib/index.mjs +1 -1
- package/build/lib/types.d.ts +3 -1
- package/build/lib/useQuery.d.ts +0 -3
- package/build/lib/useQuery.esm.js +0 -1
- package/build/lib/useQuery.esm.js.map +1 -1
- package/build/lib/useQuery.js +0 -1
- package/build/lib/useQuery.js.map +1 -1
- package/build/lib/useQuery.mjs +0 -1
- package/build/lib/useQuery.mjs.map +1 -1
- package/build/lib/useSuspenseQueries.d.ts +1 -2
- package/build/lib/useSuspenseQueries.esm.js.map +1 -1
- package/build/lib/useSuspenseQueries.js.map +1 -1
- package/build/lib/useSuspenseQueries.mjs.map +1 -1
- package/build/lib/useSuspenseQuery.d.ts +2 -6
- package/build/lib/useSuspenseQuery.esm.js +4 -1
- package/build/lib/useSuspenseQuery.esm.js.map +1 -1
- package/build/lib/useSuspenseQuery.js +4 -1
- package/build/lib/useSuspenseQuery.js.map +1 -1
- package/build/lib/useSuspenseQuery.mjs +4 -1
- package/build/lib/useSuspenseQuery.mjs.map +1 -1
- package/build/umd/index.development.js +8 -6
- package/build/umd/index.development.js.map +1 -1
- package/build/umd/index.production.js +1 -1
- package/build/umd/index.production.js.map +1 -1
- package/package.json +2 -2
- package/src/__tests__/Hydrate.test.tsx +1 -1
- package/src/__tests__/queryOptions.types.test.tsx +6 -5
- package/src/__tests__/useQuery.types.test.tsx +35 -0
- package/src/__tests__/useSuspenseQueries.types.test.tsx +5 -3
- package/src/__tests__/useSuspenseQuery.types.test.tsx +1 -5
- package/src/index.ts +9 -1
- package/src/types.ts +29 -0
- package/src/useQuery.ts +0 -21
- package/src/useSuspenseQueries.ts +3 -3
- package/src/useSuspenseQuery.ts +5 -37
package/build/lib/index.d.ts
CHANGED
|
@@ -6,6 +6,9 @@ export type { QueriesResults, QueriesOptions } from './useQueries';
|
|
|
6
6
|
export { useQuery } from './useQuery';
|
|
7
7
|
export { useSuspenseQuery } from './useSuspenseQuery';
|
|
8
8
|
export { useSuspenseQueries } from './useSuspenseQueries';
|
|
9
|
+
export type { SuspenseQueriesResults, SuspenseQueriesOptions, } from './useSuspenseQueries';
|
|
10
|
+
export { queryOptions } from './queryOptions';
|
|
11
|
+
export type { DefinedInitialDataOptions, UndefinedInitialDataOptions, } from './queryOptions';
|
|
9
12
|
export { defaultContext, QueryClientProvider, useQueryClient, } from './QueryClientProvider';
|
|
10
13
|
export type { QueryClientProviderProps } from './QueryClientProvider';
|
|
11
14
|
export type { QueryErrorResetBoundaryProps } from './QueryErrorResetBoundary';
|
|
@@ -17,5 +20,4 @@ export { useIsMutating } from './useIsMutating';
|
|
|
17
20
|
export { useMutation } from './useMutation';
|
|
18
21
|
export { useInfiniteQuery } from './useInfiniteQuery';
|
|
19
22
|
export { useIsRestoring, IsRestoringProvider } from './isRestoring';
|
|
20
|
-
export { queryOptions } from './queryOptions';
|
|
21
23
|
//# sourceMappingURL=index.d.ts.map
|
package/build/lib/index.esm.js
CHANGED
|
@@ -4,6 +4,7 @@ export { useQueries } from './useQueries.esm.js';
|
|
|
4
4
|
export { useQuery } from './useQuery.esm.js';
|
|
5
5
|
export { useSuspenseQuery } from './useSuspenseQuery.esm.js';
|
|
6
6
|
export { useSuspenseQueries } from './useSuspenseQueries.esm.js';
|
|
7
|
+
export { queryOptions } from './queryOptions.esm.js';
|
|
7
8
|
export { QueryClientProvider, defaultContext, useQueryClient } from './QueryClientProvider.esm.js';
|
|
8
9
|
export { Hydrate, useHydrate } from './Hydrate.esm.js';
|
|
9
10
|
export { QueryErrorResetBoundary, useQueryErrorResetBoundary } from './QueryErrorResetBoundary.esm.js';
|
|
@@ -12,5 +13,4 @@ export { useIsMutating } from './useIsMutating.esm.js';
|
|
|
12
13
|
export { useMutation } from './useMutation.esm.js';
|
|
13
14
|
export { useInfiniteQuery } from './useInfiniteQuery.esm.js';
|
|
14
15
|
export { IsRestoringProvider, useIsRestoring } from './isRestoring.esm.js';
|
|
15
|
-
export { queryOptions } from './queryOptions.esm.js';
|
|
16
16
|
//# sourceMappingURL=index.esm.js.map
|
package/build/lib/index.js
CHANGED
|
@@ -8,6 +8,7 @@ var useQueries = require('./useQueries.js');
|
|
|
8
8
|
var useQuery = require('./useQuery.js');
|
|
9
9
|
var useSuspenseQuery = require('./useSuspenseQuery.js');
|
|
10
10
|
var useSuspenseQueries = require('./useSuspenseQueries.js');
|
|
11
|
+
var queryOptions = require('./queryOptions.js');
|
|
11
12
|
var QueryClientProvider = require('./QueryClientProvider.js');
|
|
12
13
|
var Hydrate = require('./Hydrate.js');
|
|
13
14
|
var QueryErrorResetBoundary = require('./QueryErrorResetBoundary.js');
|
|
@@ -16,7 +17,6 @@ var useIsMutating = require('./useIsMutating.js');
|
|
|
16
17
|
var useMutation = require('./useMutation.js');
|
|
17
18
|
var useInfiniteQuery = require('./useInfiniteQuery.js');
|
|
18
19
|
var isRestoring = require('./isRestoring.js');
|
|
19
|
-
var queryOptions = require('./queryOptions.js');
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -24,6 +24,7 @@ exports.useQueries = useQueries.useQueries;
|
|
|
24
24
|
exports.useQuery = useQuery.useQuery;
|
|
25
25
|
exports.useSuspenseQuery = useSuspenseQuery.useSuspenseQuery;
|
|
26
26
|
exports.useSuspenseQueries = useSuspenseQueries.useSuspenseQueries;
|
|
27
|
+
exports.queryOptions = queryOptions.queryOptions;
|
|
27
28
|
exports.QueryClientProvider = QueryClientProvider.QueryClientProvider;
|
|
28
29
|
exports.defaultContext = QueryClientProvider.defaultContext;
|
|
29
30
|
exports.useQueryClient = QueryClientProvider.useQueryClient;
|
|
@@ -37,7 +38,6 @@ exports.useMutation = useMutation.useMutation;
|
|
|
37
38
|
exports.useInfiniteQuery = useInfiniteQuery.useInfiniteQuery;
|
|
38
39
|
exports.IsRestoringProvider = isRestoring.IsRestoringProvider;
|
|
39
40
|
exports.useIsRestoring = isRestoring.useIsRestoring;
|
|
40
|
-
exports.queryOptions = queryOptions.queryOptions;
|
|
41
41
|
Object.keys(queryCore).forEach(function (k) {
|
|
42
42
|
if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
|
|
43
43
|
enumerable: true,
|
package/build/lib/index.mjs
CHANGED
|
@@ -4,6 +4,7 @@ export { useQueries } from './useQueries.mjs';
|
|
|
4
4
|
export { useQuery } from './useQuery.mjs';
|
|
5
5
|
export { useSuspenseQuery } from './useSuspenseQuery.mjs';
|
|
6
6
|
export { useSuspenseQueries } from './useSuspenseQueries.mjs';
|
|
7
|
+
export { queryOptions } from './queryOptions.mjs';
|
|
7
8
|
export { QueryClientProvider, defaultContext, useQueryClient } from './QueryClientProvider.mjs';
|
|
8
9
|
export { Hydrate, useHydrate } from './Hydrate.mjs';
|
|
9
10
|
export { QueryErrorResetBoundary, useQueryErrorResetBoundary } from './QueryErrorResetBoundary.mjs';
|
|
@@ -12,5 +13,4 @@ export { useIsMutating } from './useIsMutating.mjs';
|
|
|
12
13
|
export { useMutation } from './useMutation.mjs';
|
|
13
14
|
export { useInfiniteQuery } from './useInfiniteQuery.mjs';
|
|
14
15
|
export { IsRestoringProvider, useIsRestoring } from './isRestoring.mjs';
|
|
15
|
-
export { queryOptions } from './queryOptions.mjs';
|
|
16
16
|
//# sourceMappingURL=index.mjs.map
|
package/build/lib/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as React from 'react';
|
|
2
|
-
import type { DefinedQueryObserverResult, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutateFunction, MutationObserverOptions, MutationObserverResult, QueryKey, QueryObserverOptions, QueryObserverResult } from '@tanstack/query-core';
|
|
2
|
+
import type { DefinedQueryObserverResult, DistributiveOmit, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutateFunction, MutationObserverOptions, MutationObserverResult, OmitKeyof, QueryKey, QueryObserverOptions, QueryObserverResult } from '@tanstack/query-core';
|
|
3
3
|
import type { QueryClient } from '@tanstack/query-core';
|
|
4
4
|
export interface ContextOptions {
|
|
5
5
|
/**
|
|
@@ -11,10 +11,12 @@ export interface UseBaseQueryOptions<TQueryFnData = unknown, TError = unknown, T
|
|
|
11
11
|
}
|
|
12
12
|
export interface UseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
|
|
13
13
|
}
|
|
14
|
+
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'>;
|
|
14
15
|
export interface UseInfiniteQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends ContextOptions, InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
|
|
15
16
|
}
|
|
16
17
|
export declare type UseBaseQueryResult<TData = unknown, TError = unknown> = QueryObserverResult<TData, TError>;
|
|
17
18
|
export declare type UseQueryResult<TData = unknown, TError = unknown> = UseBaseQueryResult<TData, TError>;
|
|
19
|
+
export declare type UseSuspenseQueryResult<TData = unknown, TError = unknown> = DistributiveOmit<DefinedQueryObserverResult<TData, TError>, 'isPlaceholderData'>;
|
|
18
20
|
export declare type DefinedUseBaseQueryResult<TData = unknown, TError = unknown> = DefinedQueryObserverResult<TData, TError>;
|
|
19
21
|
export declare type DefinedUseQueryResult<TData = unknown, TError = unknown> = DefinedUseBaseQueryResult<TData, TError>;
|
|
20
22
|
export declare type UseInfiniteQueryResult<TData = unknown, TError = unknown> = InfiniteQueryObserverResult<TData, TError>;
|
package/build/lib/useQuery.d.ts
CHANGED
|
@@ -1,11 +1,8 @@
|
|
|
1
|
-
import type { DefinedInitialDataOptions, UndefinedInitialDataOptions } from './queryOptions';
|
|
2
1
|
import type { InitialDataFunction, NonUndefinedGuard, OmitKeyof, QueryFunction, QueryKey } from '@tanstack/query-core';
|
|
3
2
|
import type { DefinedUseQueryResult, UseQueryOptions, UseQueryResult } from './types';
|
|
4
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedUseQueryResult<TData, TError>;
|
|
5
3
|
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
|
|
6
4
|
initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
|
|
7
5
|
}): DefinedUseQueryResult<TData, TError>;
|
|
8
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryResult<TData, TError>;
|
|
9
6
|
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
|
|
10
7
|
initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>> | NonUndefinedGuard<TQueryFnData>;
|
|
11
8
|
}): UseQueryResult<TData, TError>;
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
import { parseQueryArgs, QueryObserver } from '@tanstack/query-core';
|
|
3
3
|
import { useBaseQuery } from './useBaseQuery.esm.js';
|
|
4
4
|
|
|
5
|
-
/** @deprecated */
|
|
6
5
|
function useQuery(arg1, arg2, arg3) {
|
|
7
6
|
const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
|
|
8
7
|
return useBaseQuery(parsedOptions, QueryObserver);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useQuery.esm.js","sources":["../../src/useQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver, parseQueryArgs } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n
|
|
1
|
+
{"version":3,"file":"useQuery.esm.js","sources":["../../src/useQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver, parseQueryArgs } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n InitialDataFunction,\n NonUndefinedGuard,\n OmitKeyof,\n QueryFunction,\n QueryKey,\n} from '@tanstack/query-core'\nimport type {\n DefinedUseQueryResult,\n UseQueryOptions,\n UseQueryResult,\n} from './types'\n\n// HOOK\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'initialData'\n > & {\n initialData:\n | NonUndefinedGuard<TQueryFnData>\n | (() => NonUndefinedGuard<TQueryFnData>)\n },\n): DefinedUseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'initialData'\n > & {\n initialData?:\n | undefined\n | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>\n | NonUndefinedGuard<TQueryFnData>\n },\n): UseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UseQueryResult<TData, TError>\n\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'initialData'\n >,\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'initialData'\n > & { initialData: TQueryFnData | (() => TQueryFnData) },\n): DefinedUseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey'\n >,\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn' | 'initialData'\n > & { initialData?: () => undefined },\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn' | 'initialData'\n > & { initialData: TQueryFnData | (() => TQueryFnData) },\n): DefinedUseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn'\n >,\n): UseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData,\n TError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n arg1: TQueryKey | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n arg2?:\n | QueryFunction<TQueryFnData, TQueryKey>\n | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n arg3?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UseQueryResult<TData, TError> {\n const parsedOptions = parseQueryArgs(arg1, arg2, arg3)\n return useBaseQuery(parsedOptions, QueryObserver)\n}\n"],"names":[],"mappings":";;;;AA0IO;;AAaL;AACD;;"}
|
package/build/lib/useQuery.js
CHANGED
|
@@ -6,7 +6,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
6
6
|
var queryCore = require('@tanstack/query-core');
|
|
7
7
|
var useBaseQuery = require('./useBaseQuery.js');
|
|
8
8
|
|
|
9
|
-
/** @deprecated */
|
|
10
9
|
function useQuery(arg1, arg2, arg3) {
|
|
11
10
|
const parsedOptions = queryCore.parseQueryArgs(arg1, arg2, arg3);
|
|
12
11
|
return useBaseQuery.useBaseQuery(parsedOptions, queryCore.QueryObserver);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useQuery.js","sources":["../../src/useQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver, parseQueryArgs } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n
|
|
1
|
+
{"version":3,"file":"useQuery.js","sources":["../../src/useQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver, parseQueryArgs } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n InitialDataFunction,\n NonUndefinedGuard,\n OmitKeyof,\n QueryFunction,\n QueryKey,\n} from '@tanstack/query-core'\nimport type {\n DefinedUseQueryResult,\n UseQueryOptions,\n UseQueryResult,\n} from './types'\n\n// HOOK\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'initialData'\n > & {\n initialData:\n | NonUndefinedGuard<TQueryFnData>\n | (() => NonUndefinedGuard<TQueryFnData>)\n },\n): DefinedUseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'initialData'\n > & {\n initialData?:\n | undefined\n | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>\n | NonUndefinedGuard<TQueryFnData>\n },\n): UseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UseQueryResult<TData, TError>\n\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'initialData'\n >,\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'initialData'\n > & { initialData: TQueryFnData | (() => TQueryFnData) },\n): DefinedUseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey'\n >,\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn' | 'initialData'\n > & { initialData?: () => undefined },\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn' | 'initialData'\n > & { initialData: TQueryFnData | (() => TQueryFnData) },\n): DefinedUseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn'\n >,\n): UseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData,\n TError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n arg1: TQueryKey | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n arg2?:\n | QueryFunction<TQueryFnData, TQueryKey>\n | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n arg3?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UseQueryResult<TData, TError> {\n const parsedOptions = parseQueryArgs(arg1, arg2, arg3)\n return useBaseQuery(parsedOptions, QueryObserver)\n}\n"],"names":[],"mappings":";;;;;;;;AA0IO;;AAaL;AACD;;"}
|
package/build/lib/useQuery.mjs
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
import { parseQueryArgs, QueryObserver } from '@tanstack/query-core';
|
|
3
3
|
import { useBaseQuery } from './useBaseQuery.mjs';
|
|
4
4
|
|
|
5
|
-
/** @deprecated */
|
|
6
5
|
function useQuery(arg1, arg2, arg3) {
|
|
7
6
|
const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
|
|
8
7
|
return useBaseQuery(parsedOptions, QueryObserver);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useQuery.mjs","sources":["../../src/useQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver, parseQueryArgs } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n
|
|
1
|
+
{"version":3,"file":"useQuery.mjs","sources":["../../src/useQuery.ts"],"sourcesContent":["'use client'\nimport { QueryObserver, parseQueryArgs } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n InitialDataFunction,\n NonUndefinedGuard,\n OmitKeyof,\n QueryFunction,\n QueryKey,\n} from '@tanstack/query-core'\nimport type {\n DefinedUseQueryResult,\n UseQueryOptions,\n UseQueryResult,\n} from './types'\n\n// HOOK\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'initialData'\n > & {\n initialData:\n | NonUndefinedGuard<TQueryFnData>\n | (() => NonUndefinedGuard<TQueryFnData>)\n },\n): DefinedUseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'initialData'\n > & {\n initialData?:\n | undefined\n | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>\n | NonUndefinedGuard<TQueryFnData>\n },\n): UseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UseQueryResult<TData, TError>\n\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'initialData'\n >,\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'initialData'\n > & { initialData: TQueryFnData | (() => TQueryFnData) },\n): DefinedUseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey'\n >,\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn' | 'initialData'\n > & { initialData?: () => undefined },\n): UseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn' | 'initialData'\n > & { initialData: TQueryFnData | (() => TQueryFnData) },\n): DefinedUseQueryResult<TData, TError>\n/** @deprecated */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n queryKey: TQueryKey,\n queryFn: QueryFunction<TQueryFnData, TQueryKey>,\n options?: OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'queryKey' | 'queryFn'\n >,\n): UseQueryResult<TData, TError>\nexport function useQuery<\n TQueryFnData,\n TError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n arg1: TQueryKey | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n arg2?:\n | QueryFunction<TQueryFnData, TQueryKey>\n | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n arg3?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UseQueryResult<TData, TError> {\n const parsedOptions = parseQueryArgs(arg1, arg2, arg3)\n return useBaseQuery(parsedOptions, QueryObserver)\n}\n"],"names":[],"mappings":";;;;AA0IO;;AAaL;AACD;;"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import type { UseQueryOptions } from './types';
|
|
1
|
+
import type { UseQueryOptions, UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types';
|
|
2
2
|
import type { QueryFunction } from '@tanstack/query-core';
|
|
3
|
-
import type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery';
|
|
4
3
|
declare type MAXIMUM_DEPTH = 20;
|
|
5
4
|
declare type GetSuspenseOptions<T> = T extends {
|
|
6
5
|
queryFnData: infer TQueryFnData;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useSuspenseQueries.esm.js","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type {
|
|
1
|
+
{"version":3,"file":"useSuspenseQueries.esm.js","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type {\n UseQueryOptions,\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from './types'\nimport type { NetworkMode, QueryFunction } from '@tanstack/query-core'\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;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useSuspenseQueries.js","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type {
|
|
1
|
+
{"version":3,"file":"useSuspenseQueries.js","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type {\n UseQueryOptions,\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from './types'\nimport type { NetworkMode, QueryFunction } from '@tanstack/query-core'\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;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useSuspenseQueries.mjs","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type {
|
|
1
|
+
{"version":3,"file":"useSuspenseQueries.mjs","sources":["../../src/useSuspenseQueries.ts"],"sourcesContent":["import { useQueries } from './useQueries'\nimport type {\n UseQueryOptions,\n UseSuspenseQueryOptions,\n UseSuspenseQueryResult,\n} from './types'\nimport type { NetworkMode, QueryFunction } from '@tanstack/query-core'\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;;;;"}
|
|
@@ -1,8 +1,4 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
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'>;
|
|
1
|
+
import type { QueryKey } from '@tanstack/query-core';
|
|
2
|
+
import type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types';
|
|
6
3
|
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
4
|
//# sourceMappingURL=useSuspenseQuery.d.ts.map
|
|
@@ -7,7 +7,10 @@ function useSuspenseQuery(options) {
|
|
|
7
7
|
useErrorBoundary: true,
|
|
8
8
|
suspense: true,
|
|
9
9
|
placeholderData: undefined,
|
|
10
|
-
networkMode: 'always'
|
|
10
|
+
networkMode: 'always',
|
|
11
|
+
onSuccess: undefined,
|
|
12
|
+
onError: undefined,
|
|
13
|
+
onSettled: undefined
|
|
11
14
|
}, QueryObserver);
|
|
12
15
|
}
|
|
13
16
|
|
|
@@ -1 +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 {
|
|
1
|
+
{"version":3,"file":"useSuspenseQuery.esm.js","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type { QueryKey } from '@tanstack/query-core'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\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 onSuccess: undefined,\n onError: undefined,\n onSettled: undefined,\n },\n QueryObserver,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"names":["useSuspenseQuery","options","useBaseQuery","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode","onSuccess","onError","onSettled","QueryObserver"],"mappings":";;;AAKO,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,QANf;AAOEC,IAAAA,SAAS,EAAEF,SAPb;AAQEG,IAAAA,OAAO,EAAEH,SARX;AASEI,IAAAA,SAAS,EAAEJ,SAAAA;GAVI,EAYjBK,aAZiB,CAAnB,CAAA;AAcD;;;;"}
|
|
@@ -11,7 +11,10 @@ function useSuspenseQuery(options) {
|
|
|
11
11
|
useErrorBoundary: true,
|
|
12
12
|
suspense: true,
|
|
13
13
|
placeholderData: undefined,
|
|
14
|
-
networkMode: 'always'
|
|
14
|
+
networkMode: 'always',
|
|
15
|
+
onSuccess: undefined,
|
|
16
|
+
onError: undefined,
|
|
17
|
+
onSettled: undefined
|
|
15
18
|
}, queryCore.QueryObserver);
|
|
16
19
|
}
|
|
17
20
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useSuspenseQuery.js","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {
|
|
1
|
+
{"version":3,"file":"useSuspenseQuery.js","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type { QueryKey } from '@tanstack/query-core'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\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 onSuccess: undefined,\n onError: undefined,\n onSettled: undefined,\n },\n QueryObserver,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"names":["useSuspenseQuery","options","useBaseQuery","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode","onSuccess","onError","onSettled","QueryObserver"],"mappings":";;;;;;;AAKO,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,QANf;AAOEC,IAAAA,SAAS,EAAEF,SAPb;AAQEG,IAAAA,OAAO,EAAEH,SARX;AASEI,IAAAA,SAAS,EAAEJ,SAAAA;GAVI,EAYjBK,uBAZiB,CAAnB,CAAA;AAcD;;;;"}
|
|
@@ -7,7 +7,10 @@ function useSuspenseQuery(options) {
|
|
|
7
7
|
useErrorBoundary: true,
|
|
8
8
|
suspense: true,
|
|
9
9
|
placeholderData: undefined,
|
|
10
|
-
networkMode: 'always'
|
|
10
|
+
networkMode: 'always',
|
|
11
|
+
onSuccess: undefined,
|
|
12
|
+
onError: undefined,
|
|
13
|
+
onSettled: undefined
|
|
11
14
|
}, QueryObserver);
|
|
12
15
|
}
|
|
13
16
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useSuspenseQuery.mjs","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {
|
|
1
|
+
{"version":3,"file":"useSuspenseQuery.mjs","sources":["../../src/useSuspenseQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type { QueryKey } from '@tanstack/query-core'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'\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 onSuccess: undefined,\n onError: undefined,\n onSettled: undefined,\n },\n QueryObserver,\n ) as UseSuspenseQueryResult<TData, TError>\n}\n"],"names":["useSuspenseQuery","options","useBaseQuery","enabled","useErrorBoundary","suspense","placeholderData","undefined","networkMode","onSuccess","onError","onSettled","QueryObserver"],"mappings":";;;AAKO,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,QANf;AAOEC,IAAAA,SAAS,EAAEF,SAPb;AAQEG,IAAAA,OAAO,EAAEH,SARX;AASEI,IAAAA,SAAS,EAAEJ,SAAAA;GAVI,EAYjBK,aAZiB,CAAnB,CAAA;AAcD;;;;"}
|
|
@@ -3888,7 +3888,6 @@
|
|
|
3888
3888
|
return !defaultedOptions.notifyOnChangeProps ? observer.trackResult(result) : result;
|
|
3889
3889
|
}
|
|
3890
3890
|
|
|
3891
|
-
/** @deprecated */
|
|
3892
3891
|
function useQuery(arg1, arg2, arg3) {
|
|
3893
3892
|
const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
|
|
3894
3893
|
return useBaseQuery(parsedOptions, QueryObserver);
|
|
@@ -3900,7 +3899,10 @@
|
|
|
3900
3899
|
useErrorBoundary: true,
|
|
3901
3900
|
suspense: true,
|
|
3902
3901
|
placeholderData: undefined,
|
|
3903
|
-
networkMode: 'always'
|
|
3902
|
+
networkMode: 'always',
|
|
3903
|
+
onSuccess: undefined,
|
|
3904
|
+
onError: undefined,
|
|
3905
|
+
onSettled: undefined
|
|
3904
3906
|
}, QueryObserver);
|
|
3905
3907
|
}
|
|
3906
3908
|
|
|
@@ -3920,6 +3922,10 @@
|
|
|
3920
3922
|
});
|
|
3921
3923
|
}
|
|
3922
3924
|
|
|
3925
|
+
function queryOptions(options) {
|
|
3926
|
+
return options;
|
|
3927
|
+
}
|
|
3928
|
+
|
|
3923
3929
|
function useHydrate(state, options = {}) {
|
|
3924
3930
|
const queryClient = useQueryClient({
|
|
3925
3931
|
context: options.context
|
|
@@ -3994,10 +4000,6 @@
|
|
|
3994
4000
|
return useBaseQuery(options, InfiniteQueryObserver);
|
|
3995
4001
|
}
|
|
3996
4002
|
|
|
3997
|
-
function queryOptions(options) {
|
|
3998
|
-
return options;
|
|
3999
|
-
}
|
|
4000
|
-
|
|
4001
4003
|
exports.CancelledError = CancelledError;
|
|
4002
4004
|
exports.Hydrate = Hydrate;
|
|
4003
4005
|
exports.InfiniteQueryObserver = InfiniteQueryObserver;
|