@tanstack/preact-query 5.103.3 → 5.104.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/legacy/HydrationBoundary.d.cts +2 -3
- package/build/legacy/HydrationBoundary.d.cts.map +1 -1
- package/build/legacy/HydrationBoundary.d.ts +2 -3
- package/build/legacy/HydrationBoundary.d.ts.map +1 -1
- package/build/legacy/IsRestoringProvider.d.cts +2 -3
- package/build/legacy/IsRestoringProvider.d.cts.map +1 -1
- package/build/legacy/IsRestoringProvider.d.ts +2 -3
- package/build/legacy/IsRestoringProvider.d.ts.map +1 -1
- package/build/legacy/QueryClientProvider.d.cts +4 -5
- package/build/legacy/QueryClientProvider.d.cts.map +1 -1
- package/build/legacy/QueryClientProvider.d.ts +4 -5
- package/build/legacy/QueryClientProvider.d.ts.map +1 -1
- package/build/legacy/QueryErrorResetBoundary.d.cts +8 -9
- package/build/legacy/QueryErrorResetBoundary.d.cts.map +1 -1
- package/build/legacy/QueryErrorResetBoundary.d.ts +8 -9
- package/build/legacy/QueryErrorResetBoundary.d.ts.map +1 -1
- package/build/legacy/errorBoundaryUtils.d.cts +3 -4
- package/build/legacy/errorBoundaryUtils.d.cts.map +1 -1
- package/build/legacy/errorBoundaryUtils.d.ts +3 -4
- package/build/legacy/errorBoundaryUtils.d.ts.map +1 -1
- package/build/legacy/infiniteQueryOptions.d.cts +6 -7
- package/build/legacy/infiniteQueryOptions.d.cts.map +1 -1
- package/build/legacy/infiniteQueryOptions.d.ts +6 -7
- package/build/legacy/infiniteQueryOptions.d.ts.map +1 -1
- package/build/legacy/mutationOptions.d.cts +2 -3
- package/build/legacy/mutationOptions.d.cts.map +1 -1
- package/build/legacy/mutationOptions.d.ts +2 -3
- package/build/legacy/mutationOptions.d.ts.map +1 -1
- package/build/legacy/queryOptions.d.cts +6 -7
- package/build/legacy/queryOptions.d.cts.map +1 -1
- package/build/legacy/queryOptions.d.ts +6 -7
- package/build/legacy/queryOptions.d.ts.map +1 -1
- package/build/legacy/suspense.d.cts +4 -5
- package/build/legacy/suspense.d.cts.map +1 -1
- package/build/legacy/suspense.d.ts +4 -5
- package/build/legacy/suspense.d.ts.map +1 -1
- package/build/legacy/types.d.cts +25 -26
- package/build/legacy/types.d.cts.map +1 -1
- package/build/legacy/types.d.ts +25 -26
- package/build/legacy/types.d.ts.map +1 -1
- package/build/legacy/useBaseQuery.d.cts +1 -2
- package/build/legacy/useBaseQuery.d.cts.map +1 -1
- package/build/legacy/useBaseQuery.d.ts +1 -2
- package/build/legacy/useBaseQuery.d.ts.map +1 -1
- package/build/legacy/useInfiniteQuery.d.cts +3 -4
- package/build/legacy/useInfiniteQuery.d.cts.map +1 -1
- package/build/legacy/useInfiniteQuery.d.ts +3 -4
- package/build/legacy/useInfiniteQuery.d.ts.map +1 -1
- package/build/legacy/useIsFetching.d.cts +1 -2
- package/build/legacy/useIsFetching.d.cts.map +1 -1
- package/build/legacy/useIsFetching.d.ts +1 -2
- package/build/legacy/useIsFetching.d.ts.map +1 -1
- package/build/legacy/useMutation.d.cts +1 -2
- package/build/legacy/useMutation.d.cts.map +1 -1
- package/build/legacy/useMutation.d.ts +1 -2
- package/build/legacy/useMutation.d.ts.map +1 -1
- package/build/legacy/useMutationState.d.cts +2 -3
- package/build/legacy/useMutationState.d.cts.map +1 -1
- package/build/legacy/useMutationState.d.ts +2 -3
- package/build/legacy/useMutationState.d.ts.map +1 -1
- package/build/legacy/usePrefetchInfiniteQuery.d.cts +1 -2
- package/build/legacy/usePrefetchInfiniteQuery.d.cts.map +1 -1
- package/build/legacy/usePrefetchInfiniteQuery.d.ts +1 -2
- package/build/legacy/usePrefetchInfiniteQuery.d.ts.map +1 -1
- package/build/legacy/usePrefetchQuery.d.cts +1 -2
- package/build/legacy/usePrefetchQuery.d.cts.map +1 -1
- package/build/legacy/usePrefetchQuery.d.ts +1 -2
- package/build/legacy/usePrefetchQuery.d.ts.map +1 -1
- package/build/legacy/useQueries.d.cts +3 -4
- package/build/legacy/useQueries.d.cts.map +1 -1
- package/build/legacy/useQueries.d.ts +3 -4
- package/build/legacy/useQueries.d.ts.map +1 -1
- package/build/legacy/useQuery.d.cts +3 -4
- package/build/legacy/useQuery.d.cts.map +1 -1
- package/build/legacy/useQuery.d.ts +3 -4
- package/build/legacy/useQuery.d.ts.map +1 -1
- package/build/legacy/useSuspenseInfiniteQuery.d.cts +1 -2
- package/build/legacy/useSuspenseInfiniteQuery.d.cts.map +1 -1
- package/build/legacy/useSuspenseInfiniteQuery.d.ts +1 -2
- package/build/legacy/useSuspenseInfiniteQuery.d.ts.map +1 -1
- package/build/legacy/useSuspenseQueries.d.cts +4 -5
- package/build/legacy/useSuspenseQueries.d.cts.map +1 -1
- package/build/legacy/useSuspenseQueries.d.ts +4 -5
- package/build/legacy/useSuspenseQueries.d.ts.map +1 -1
- package/build/legacy/useSuspenseQuery.d.cts +1 -2
- package/build/legacy/useSuspenseQuery.d.cts.map +1 -1
- package/build/legacy/useSuspenseQuery.d.ts +1 -2
- package/build/legacy/useSuspenseQuery.d.ts.map +1 -1
- package/build/legacy/utils.d.cts +2 -3
- package/build/legacy/utils.d.cts.map +1 -1
- package/build/legacy/utils.d.ts +2 -3
- package/build/legacy/utils.d.ts.map +1 -1
- package/build/modern/HydrationBoundary.d.cts +2 -3
- package/build/modern/HydrationBoundary.d.cts.map +1 -1
- package/build/modern/HydrationBoundary.d.ts +2 -3
- package/build/modern/HydrationBoundary.d.ts.map +1 -1
- package/build/modern/IsRestoringProvider.d.cts +2 -3
- package/build/modern/IsRestoringProvider.d.cts.map +1 -1
- package/build/modern/IsRestoringProvider.d.ts +2 -3
- package/build/modern/IsRestoringProvider.d.ts.map +1 -1
- package/build/modern/QueryClientProvider.d.cts +4 -5
- package/build/modern/QueryClientProvider.d.cts.map +1 -1
- package/build/modern/QueryClientProvider.d.ts +4 -5
- package/build/modern/QueryClientProvider.d.ts.map +1 -1
- package/build/modern/QueryErrorResetBoundary.d.cts +8 -9
- package/build/modern/QueryErrorResetBoundary.d.cts.map +1 -1
- package/build/modern/QueryErrorResetBoundary.d.ts +8 -9
- package/build/modern/QueryErrorResetBoundary.d.ts.map +1 -1
- package/build/modern/errorBoundaryUtils.d.cts +3 -4
- package/build/modern/errorBoundaryUtils.d.cts.map +1 -1
- package/build/modern/errorBoundaryUtils.d.ts +3 -4
- package/build/modern/errorBoundaryUtils.d.ts.map +1 -1
- package/build/modern/infiniteQueryOptions.d.cts +6 -7
- package/build/modern/infiniteQueryOptions.d.cts.map +1 -1
- package/build/modern/infiniteQueryOptions.d.ts +6 -7
- package/build/modern/infiniteQueryOptions.d.ts.map +1 -1
- package/build/modern/mutationOptions.d.cts +2 -3
- package/build/modern/mutationOptions.d.cts.map +1 -1
- package/build/modern/mutationOptions.d.ts +2 -3
- package/build/modern/mutationOptions.d.ts.map +1 -1
- package/build/modern/queryOptions.d.cts +6 -7
- package/build/modern/queryOptions.d.cts.map +1 -1
- package/build/modern/queryOptions.d.ts +6 -7
- package/build/modern/queryOptions.d.ts.map +1 -1
- package/build/modern/suspense.d.cts +4 -5
- package/build/modern/suspense.d.cts.map +1 -1
- package/build/modern/suspense.d.ts +4 -5
- package/build/modern/suspense.d.ts.map +1 -1
- package/build/modern/types.d.cts +25 -26
- package/build/modern/types.d.cts.map +1 -1
- package/build/modern/types.d.ts +25 -26
- package/build/modern/types.d.ts.map +1 -1
- package/build/modern/useBaseQuery.d.cts +1 -2
- package/build/modern/useBaseQuery.d.cts.map +1 -1
- package/build/modern/useBaseQuery.d.ts +1 -2
- package/build/modern/useBaseQuery.d.ts.map +1 -1
- package/build/modern/useInfiniteQuery.d.cts +3 -4
- package/build/modern/useInfiniteQuery.d.cts.map +1 -1
- package/build/modern/useInfiniteQuery.d.ts +3 -4
- package/build/modern/useInfiniteQuery.d.ts.map +1 -1
- package/build/modern/useIsFetching.d.cts +1 -2
- package/build/modern/useIsFetching.d.cts.map +1 -1
- package/build/modern/useIsFetching.d.ts +1 -2
- package/build/modern/useIsFetching.d.ts.map +1 -1
- package/build/modern/useMutation.d.cts +1 -2
- package/build/modern/useMutation.d.cts.map +1 -1
- package/build/modern/useMutation.d.ts +1 -2
- package/build/modern/useMutation.d.ts.map +1 -1
- package/build/modern/useMutationState.d.cts +2 -3
- package/build/modern/useMutationState.d.cts.map +1 -1
- package/build/modern/useMutationState.d.ts +2 -3
- package/build/modern/useMutationState.d.ts.map +1 -1
- package/build/modern/usePrefetchInfiniteQuery.d.cts +1 -2
- package/build/modern/usePrefetchInfiniteQuery.d.cts.map +1 -1
- package/build/modern/usePrefetchInfiniteQuery.d.ts +1 -2
- package/build/modern/usePrefetchInfiniteQuery.d.ts.map +1 -1
- package/build/modern/usePrefetchQuery.d.cts +1 -2
- package/build/modern/usePrefetchQuery.d.cts.map +1 -1
- package/build/modern/usePrefetchQuery.d.ts +1 -2
- package/build/modern/usePrefetchQuery.d.ts.map +1 -1
- package/build/modern/useQueries.d.cts +3 -4
- package/build/modern/useQueries.d.cts.map +1 -1
- package/build/modern/useQueries.d.ts +3 -4
- package/build/modern/useQueries.d.ts.map +1 -1
- package/build/modern/useQuery.d.cts +3 -4
- package/build/modern/useQuery.d.cts.map +1 -1
- package/build/modern/useQuery.d.ts +3 -4
- package/build/modern/useQuery.d.ts.map +1 -1
- package/build/modern/useSuspenseInfiniteQuery.d.cts +1 -2
- package/build/modern/useSuspenseInfiniteQuery.d.cts.map +1 -1
- package/build/modern/useSuspenseInfiniteQuery.d.ts +1 -2
- package/build/modern/useSuspenseInfiniteQuery.d.ts.map +1 -1
- package/build/modern/useSuspenseQueries.d.cts +4 -5
- package/build/modern/useSuspenseQueries.d.cts.map +1 -1
- package/build/modern/useSuspenseQueries.d.ts +4 -5
- package/build/modern/useSuspenseQueries.d.ts.map +1 -1
- package/build/modern/useSuspenseQuery.d.cts +1 -2
- package/build/modern/useSuspenseQuery.d.cts.map +1 -1
- package/build/modern/useSuspenseQuery.d.ts +1 -2
- package/build/modern/useSuspenseQuery.d.ts.map +1 -1
- package/build/modern/utils.d.cts +2 -3
- package/build/modern/utils.d.cts.map +1 -1
- package/build/modern/utils.d.ts +2 -3
- package/build/modern/utils.d.ts.map +1 -1
- package/package.json +3 -3
|
@@ -10,7 +10,7 @@ import { DefaultError, InitialDataFunction, NonUndefinedGuard, OmitKeyof, QueryF
|
|
|
10
10
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
11
11
|
* @template TQueryKey - The type of your `queryKey`.
|
|
12
12
|
*/
|
|
13
|
-
type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
13
|
+
export type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
14
14
|
/**
|
|
15
15
|
* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been
|
|
16
16
|
* created or cached yet). If set to a function, the function will be called **once** during the shared/root
|
|
@@ -29,7 +29,7 @@ type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError,
|
|
|
29
29
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
30
30
|
* @template TQueryKey - The type of your `queryKey`.
|
|
31
31
|
*/
|
|
32
|
-
type UnusedSkipTokenOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
32
|
+
export type UnusedSkipTokenOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
33
33
|
/**
|
|
34
34
|
* `skipToken` is not allowed as a value here — this overload is selected when no `initialData` is set. If
|
|
35
35
|
* you don't intend to run the query yet, set `enabled: false` — omitting `queryFn` alone still triggers a
|
|
@@ -47,7 +47,7 @@ type UnusedSkipTokenOptions<TQueryFnData = unknown, TError = DefaultError, TData
|
|
|
47
47
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
48
48
|
* @template TQueryKey - The type of your `queryKey`.
|
|
49
49
|
*/
|
|
50
|
-
type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
50
|
+
export type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
51
51
|
/**
|
|
52
52
|
* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been
|
|
53
53
|
* created or cached yet). If set to a function, the function will be called **once** during the shared/root
|
|
@@ -102,7 +102,7 @@ type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TD
|
|
|
102
102
|
* }
|
|
103
103
|
* ```
|
|
104
104
|
*/
|
|
105
|
-
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
105
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
106
106
|
/**
|
|
107
107
|
* You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can
|
|
108
108
|
* be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
|
|
@@ -134,7 +134,7 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
134
134
|
* }
|
|
135
135
|
* ```
|
|
136
136
|
*/
|
|
137
|
-
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
137
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
138
138
|
/**
|
|
139
139
|
* You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can
|
|
140
140
|
* be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
|
|
@@ -189,7 +189,6 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
189
189
|
* }
|
|
190
190
|
* ```
|
|
191
191
|
*/
|
|
192
|
-
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
192
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
193
193
|
//#endregion
|
|
194
|
-
export { DefinedInitialDataOptions, UndefinedInitialDataOptions, UnusedSkipTokenOptions, queryOptions };
|
|
195
194
|
//# sourceMappingURL=queryOptions.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queryOptions.d.cts","names":[],"sources":["../../src/queryOptions.ts"],"mappings":";;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"queryOptions.d.cts","names":[],"sources":["../../src/queryOptions.ts"],"mappings":";;;;;;;;;;;;YAsBY,4BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO;;;;;;;;EAQ/C,0BAEI,oBAAoB,kBAAkB,iBACtC,kBAAkB;;;;;;;;;;;YAYZ,uBACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,UACF,gBAAgB,cAAc,QAAQ,OAAO;;;;;;;EAS7C,UAAU,QACR,gBAAgB,cAAc,QAAQ,OAAO,uBAC7C;;;;;;;;;;;YAaQ,0BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,KAAK,gBAAgB,cAAc,QAAQ,OAAO;;;;;;;;EAQpD,aACE,kBAAkB,uBAAuB,kBAAkB;;;;;;EAM7D,UAAU,cAAc,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA0CxB,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,0BAA0B,cAAc,QAAQ,OAAO,aAC/D,0BAA0B,cAAc,QAAQ,OAAO,aACxD,oBAAoB,WAAW,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAiC/B,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,uBAAuB,cAAc,QAAQ,OAAO,aAC5D,uBAAuB,cAAc,QAAQ,OAAO,aACrD,oBAAoB,WAAW,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAwD/B,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,4BAA4B,cAAc,QAAQ,OAAO,aACjE,4BAA4B,cAAc,QAAQ,OAAO,aAC1D,oBAAoB,WAAW,cAAc"}
|
|
@@ -10,7 +10,7 @@ import { DefaultError, InitialDataFunction, NonUndefinedGuard, OmitKeyof, QueryF
|
|
|
10
10
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
11
11
|
* @template TQueryKey - The type of your `queryKey`.
|
|
12
12
|
*/
|
|
13
|
-
type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
13
|
+
export type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
14
14
|
/**
|
|
15
15
|
* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been
|
|
16
16
|
* created or cached yet). If set to a function, the function will be called **once** during the shared/root
|
|
@@ -29,7 +29,7 @@ type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError,
|
|
|
29
29
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
30
30
|
* @template TQueryKey - The type of your `queryKey`.
|
|
31
31
|
*/
|
|
32
|
-
type UnusedSkipTokenOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
32
|
+
export type UnusedSkipTokenOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
33
33
|
/**
|
|
34
34
|
* `skipToken` is not allowed as a value here — this overload is selected when no `initialData` is set. If
|
|
35
35
|
* you don't intend to run the query yet, set `enabled: false` — omitting `queryFn` alone still triggers a
|
|
@@ -47,7 +47,7 @@ type UnusedSkipTokenOptions<TQueryFnData = unknown, TError = DefaultError, TData
|
|
|
47
47
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
48
48
|
* @template TQueryKey - The type of your `queryKey`.
|
|
49
49
|
*/
|
|
50
|
-
type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
50
|
+
export type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & {
|
|
51
51
|
/**
|
|
52
52
|
* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been
|
|
53
53
|
* created or cached yet). If set to a function, the function will be called **once** during the shared/root
|
|
@@ -102,7 +102,7 @@ type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TD
|
|
|
102
102
|
* }
|
|
103
103
|
* ```
|
|
104
104
|
*/
|
|
105
|
-
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
105
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
106
106
|
/**
|
|
107
107
|
* You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can
|
|
108
108
|
* be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
|
|
@@ -134,7 +134,7 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
134
134
|
* }
|
|
135
135
|
* ```
|
|
136
136
|
*/
|
|
137
|
-
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
137
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
138
138
|
/**
|
|
139
139
|
* You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can
|
|
140
140
|
* be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
|
|
@@ -189,7 +189,6 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
189
189
|
* }
|
|
190
190
|
* ```
|
|
191
191
|
*/
|
|
192
|
-
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
192
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
|
|
193
193
|
//#endregion
|
|
194
|
-
export { DefinedInitialDataOptions, UndefinedInitialDataOptions, UnusedSkipTokenOptions, queryOptions };
|
|
195
194
|
//# sourceMappingURL=queryOptions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queryOptions.d.ts","names":[],"sources":["../../src/queryOptions.ts"],"mappings":";;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"queryOptions.d.ts","names":[],"sources":["../../src/queryOptions.ts"],"mappings":";;;;;;;;;;;;YAsBY,4BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO;;;;;;;;EAQ/C,0BAEI,oBAAoB,kBAAkB,iBACtC,kBAAkB;;;;;;;;;;;YAYZ,uBACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,UACF,gBAAgB,cAAc,QAAQ,OAAO;;;;;;;EAS7C,UAAU,QACR,gBAAgB,cAAc,QAAQ,OAAO,uBAC7C;;;;;;;;;;;YAaQ,0BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,KAAK,gBAAgB,cAAc,QAAQ,OAAO;;;;;;;;EAQpD,aACE,kBAAkB,uBAAuB,kBAAkB;;;;;;EAM7D,UAAU,cAAc,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA0CxB,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,0BAA0B,cAAc,QAAQ,OAAO,aAC/D,0BAA0B,cAAc,QAAQ,OAAO,aACxD,oBAAoB,WAAW,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAiC/B,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,uBAAuB,cAAc,QAAQ,OAAO,aAC5D,uBAAuB,cAAc,QAAQ,OAAO,aACrD,oBAAoB,WAAW,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAwD/B,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,4BAA4B,cAAc,QAAQ,OAAO,aACjE,4BAA4B,cAAc,QAAQ,OAAO,aAC1D,oBAAoB,WAAW,cAAc"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { QueryErrorResetBoundaryValue } from "./QueryErrorResetBoundary.cjs";
|
|
2
2
|
import { DefaultError, DefaultedQueryObserverOptions, Query, QueryKey, QueryObserver, QueryObserverResult } from "@tanstack/query-core";
|
|
3
3
|
//#region src/suspense.d.ts
|
|
4
|
-
declare const defaultThrowOnError: <TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(_error: TError, query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean;
|
|
5
|
-
declare const ensureSuspenseTimers: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any>) => void;
|
|
6
|
-
declare const shouldSuspend: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any> | undefined, result: QueryObserverResult<any, any>) => boolean | undefined;
|
|
7
|
-
declare const fetchOptimistic: <TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(defaultedOptions: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, observer: QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>, errorResetBoundary: QueryErrorResetBoundaryValue) => Promise<void | QueryObserverResult<TData, TError>>;
|
|
4
|
+
export declare const defaultThrowOnError: <TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(_error: TError, query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean;
|
|
5
|
+
export declare const ensureSuspenseTimers: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any>) => void;
|
|
6
|
+
export declare const shouldSuspend: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any> | undefined, result: QueryObserverResult<any, any>) => boolean | undefined;
|
|
7
|
+
export declare const fetchOptimistic: <TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(defaultedOptions: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, observer: QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>, errorResetBoundary: QueryErrorResetBoundaryValue) => Promise<void | QueryObserverResult<TData, TError>>;
|
|
8
8
|
//#endregion
|
|
9
|
-
export { defaultThrowOnError, ensureSuspenseTimers, fetchOptimistic, shouldSuspend };
|
|
10
9
|
//# sourceMappingURL=suspense.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"suspense.d.cts","names":[],"sources":["../../src/suspense.ts"],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"suspense.d.cts","names":[],"sources":["../../src/suspense.ts"],"mappings":";;;qBAWa,sBACX,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,QAAQ,QACR,OAAO,MAAM,cAAc,QAAQ,OAAO;qBAG/B,uBACX,kBAAkB;qBA2BP,gBACX,kBACE,oEACF,QAAQ;qBAGG,kBACX,cACA,QACA,OACA,YACA,kBAAkB,UAElB,kBAAkB,8BAChB,cACA,QACA,OACA,YACA,YAEF,UAAU,cAAc,cAAc,QAAQ,OAAO,YAAY,YACjE,oBAAoB,iCAA4B,eAAA,oBAAA,OAAA"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { QueryErrorResetBoundaryValue } from "./QueryErrorResetBoundary.js";
|
|
2
2
|
import { DefaultError, DefaultedQueryObserverOptions, Query, QueryKey, QueryObserver, QueryObserverResult } from "@tanstack/query-core";
|
|
3
3
|
//#region src/suspense.d.ts
|
|
4
|
-
declare const defaultThrowOnError: <TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(_error: TError, query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean;
|
|
5
|
-
declare const ensureSuspenseTimers: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any>) => void;
|
|
6
|
-
declare const shouldSuspend: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any> | undefined, result: QueryObserverResult<any, any>) => boolean | undefined;
|
|
7
|
-
declare const fetchOptimistic: <TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(defaultedOptions: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, observer: QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>, errorResetBoundary: QueryErrorResetBoundaryValue) => Promise<void | QueryObserverResult<TData, TError>>;
|
|
4
|
+
export declare const defaultThrowOnError: <TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(_error: TError, query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean;
|
|
5
|
+
export declare const ensureSuspenseTimers: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any>) => void;
|
|
6
|
+
export declare const shouldSuspend: (defaultedOptions: DefaultedQueryObserverOptions<any, any, any, any, any> | undefined, result: QueryObserverResult<any, any>) => boolean | undefined;
|
|
7
|
+
export declare const fetchOptimistic: <TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(defaultedOptions: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, observer: QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>, errorResetBoundary: QueryErrorResetBoundaryValue) => Promise<void | QueryObserverResult<TData, TError>>;
|
|
8
8
|
//#endregion
|
|
9
|
-
export { defaultThrowOnError, ensureSuspenseTimers, fetchOptimistic, shouldSuspend };
|
|
10
9
|
//# sourceMappingURL=suspense.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"suspense.d.ts","names":[],"sources":["../../src/suspense.ts"],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"suspense.d.ts","names":[],"sources":["../../src/suspense.ts"],"mappings":";;;qBAWa,sBACX,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,QAAQ,QACR,OAAO,MAAM,cAAc,QAAQ,OAAO;qBAG/B,uBACX,kBAAkB;qBA2BP,gBACX,kBACE,oEACF,QAAQ;qBAGG,kBACX,cACA,QACA,OACA,YACA,kBAAkB,UAElB,kBAAkB,8BAChB,cACA,QACA,OACA,YACA,YAEF,UAAU,cAAc,cAAc,QAAQ,OAAO,YAAY,YACjE,oBAAoB,iCAA4B,eAAA,oBAAA,OAAA"}
|
package/build/modern/types.d.cts
CHANGED
|
@@ -4,7 +4,7 @@ import { DefaultError, DefinedInfiniteQueryObserverResult, DefinedQueryObserverR
|
|
|
4
4
|
* {@link UseBaseQueryOptions} with all type parameters set to `any`, useful when the specific types aren't
|
|
5
5
|
* relevant, e.g. when accepting options for any query in a helper function.
|
|
6
6
|
*/
|
|
7
|
-
type AnyUseBaseQueryOptions = UseBaseQueryOptions<any, any, any, any, any>;
|
|
7
|
+
export type AnyUseBaseQueryOptions = UseBaseQueryOptions<any, any, any, any, any>;
|
|
8
8
|
/**
|
|
9
9
|
* The options shared by `useQuery` and `useSuspenseQuery`. Extends {@link QueryObserverOptions} from
|
|
10
10
|
* `@tanstack/query-core` with the `preact-query`-specific `subscribed` option.
|
|
@@ -17,7 +17,7 @@ type AnyUseBaseQueryOptions = UseBaseQueryOptions<any, any, any, any, any>;
|
|
|
17
17
|
* `placeholderData`. Defaults to, and is usually the same as, `TQueryFnData`.
|
|
18
18
|
* @template TQueryKey - The type of your `queryKey`.
|
|
19
19
|
*/
|
|
20
|
-
interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
|
|
20
|
+
export interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
|
|
21
21
|
/**
|
|
22
22
|
* Set this to `false` to unsubscribe this observer from updates to the query cache.
|
|
23
23
|
*
|
|
@@ -37,7 +37,7 @@ interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
37
37
|
* `placeholderData`. Defaults to, and is usually the same as, `TQueryFnData`.
|
|
38
38
|
* @template TQueryKey - The type of your `queryKey`.
|
|
39
39
|
*/
|
|
40
|
-
type UsePrefetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = DistributiveOmit<QueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'queryFn'> & {
|
|
40
|
+
export type UsePrefetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = DistributiveOmit<QueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'queryFn'> & {
|
|
41
41
|
/**
|
|
42
42
|
* `skipToken` is not allowed as a value here — a prefetch always needs a query function to actually run,
|
|
43
43
|
* unless a default query function has been defined.
|
|
@@ -56,7 +56,7 @@ type UsePrefetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TDat
|
|
|
56
56
|
* @template TQueryKey - The type of your `queryKey`.
|
|
57
57
|
* @template TPageParam - The type of the parameter passed to `queryFn` to fetch a given page.
|
|
58
58
|
*/
|
|
59
|
-
type UsePrefetchInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = DistributiveOmit<InfiniteQueryExecuteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryFn'> & {
|
|
59
|
+
export type UsePrefetchInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = DistributiveOmit<InfiniteQueryExecuteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryFn'> & {
|
|
60
60
|
/**
|
|
61
61
|
* `skipToken` is not allowed as a value here — a prefetch always needs a query function to actually run,
|
|
62
62
|
* unless a default query function has been defined.
|
|
@@ -67,7 +67,7 @@ type UsePrefetchInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultErr
|
|
|
67
67
|
* {@link UseQueryOptions} with all type parameters set to `any`, useful when the specific types aren't
|
|
68
68
|
* relevant, e.g. when accepting options for any query in a helper function.
|
|
69
69
|
*/
|
|
70
|
-
type AnyUseQueryOptions = UseQueryOptions<any, any, any, any>;
|
|
70
|
+
export type AnyUseQueryOptions = UseQueryOptions<any, any, any, any>;
|
|
71
71
|
/**
|
|
72
72
|
* The options accepted by `useQuery`. Same as {@link UseBaseQueryOptions}, minus `suspense` (which
|
|
73
73
|
* `preact-query` derives from which hook you call rather than exposing as an option).
|
|
@@ -78,12 +78,12 @@ type AnyUseQueryOptions = UseQueryOptions<any, any, any, any>;
|
|
|
78
78
|
* `select` is used.
|
|
79
79
|
* @template TQueryKey - The type of your `queryKey`.
|
|
80
80
|
*/
|
|
81
|
-
interface UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'suspense'> {}
|
|
81
|
+
export interface UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'suspense'> {}
|
|
82
82
|
/**
|
|
83
83
|
* {@link UseSuspenseQueryOptions} with all type parameters set to `any`, useful when the specific types aren't
|
|
84
84
|
* relevant, e.g. when accepting options for any query in a helper function.
|
|
85
85
|
*/
|
|
86
|
-
type AnyUseSuspenseQueryOptions = UseSuspenseQueryOptions<any, any, any, any>;
|
|
86
|
+
export type AnyUseSuspenseQueryOptions = UseSuspenseQueryOptions<any, any, any, any>;
|
|
87
87
|
/**
|
|
88
88
|
* The options accepted by `useSuspenseQuery`. Same as {@link UseQueryOptions}, minus `enabled`, `throwOnError`,
|
|
89
89
|
* and `placeholderData` — Suspense hooks cannot render a "disabled" or "placeholder" state, so those options
|
|
@@ -95,7 +95,7 @@ type AnyUseSuspenseQueryOptions = UseSuspenseQueryOptions<any, any, any, any>;
|
|
|
95
95
|
* `select` is used.
|
|
96
96
|
* @template TQueryKey - The type of your `queryKey`.
|
|
97
97
|
*/
|
|
98
|
-
interface UseSuspenseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'> {
|
|
98
|
+
export interface UseSuspenseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'> {
|
|
99
99
|
/**
|
|
100
100
|
* `skipToken` is not allowed here — Suspense hooks cannot render a "disabled" state, so a query function
|
|
101
101
|
* must always be provided, unless a default query function has been defined.
|
|
@@ -106,7 +106,7 @@ interface UseSuspenseQueryOptions<TQueryFnData = unknown, TError = DefaultError,
|
|
|
106
106
|
* {@link UseInfiniteQueryOptions} with all type parameters set to `any`, useful when the specific types aren't
|
|
107
107
|
* relevant, e.g. when accepting options for any query in a helper function.
|
|
108
108
|
*/
|
|
109
|
-
type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<any, any, any, any, any>;
|
|
109
|
+
export type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<any, any, any, any, any>;
|
|
110
110
|
/**
|
|
111
111
|
* The options accepted by `useInfiniteQuery`. Extends {@link InfiniteQueryObserverOptions} from
|
|
112
112
|
* `@tanstack/query-core` with the `preact-query`-specific `subscribed` option, minus `suspense` (which
|
|
@@ -119,7 +119,7 @@ type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<any, any, any, any, an
|
|
|
119
119
|
* @template TQueryKey - The type of your `queryKey`.
|
|
120
120
|
* @template TPageParam - The type of the parameter passed to `queryFn` to fetch a given page.
|
|
121
121
|
*/
|
|
122
|
-
interface UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'suspense'> {
|
|
122
|
+
export interface UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'suspense'> {
|
|
123
123
|
/**
|
|
124
124
|
* Set this to `false` to unsubscribe this observer from updates to the query cache.
|
|
125
125
|
*
|
|
@@ -131,7 +131,7 @@ interface UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError,
|
|
|
131
131
|
* {@link UseSuspenseInfiniteQueryOptions} with all type parameters set to `any`, useful when the specific types
|
|
132
132
|
* aren't relevant, e.g. when accepting options for any query in a helper function.
|
|
133
133
|
*/
|
|
134
|
-
type AnyUseSuspenseInfiniteQueryOptions = UseSuspenseInfiniteQueryOptions<any, any, any, any, any>;
|
|
134
|
+
export type AnyUseSuspenseInfiniteQueryOptions = UseSuspenseInfiniteQueryOptions<any, any, any, any, any>;
|
|
135
135
|
/**
|
|
136
136
|
* The options accepted by `useSuspenseInfiniteQuery`. Same as {@link UseInfiniteQueryOptions}, minus `enabled`,
|
|
137
137
|
* `throwOnError`, and `placeholderData` — Suspense hooks cannot render a "disabled" or "placeholder" state, so
|
|
@@ -144,7 +144,7 @@ type AnyUseSuspenseInfiniteQueryOptions = UseSuspenseInfiniteQueryOptions<any, a
|
|
|
144
144
|
* @template TQueryKey - The type of your `queryKey`.
|
|
145
145
|
* @template TPageParam - The type of the parameter passed to `queryFn` to fetch a given page.
|
|
146
146
|
*/
|
|
147
|
-
interface UseSuspenseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'> {
|
|
147
|
+
export interface UseSuspenseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'> {
|
|
148
148
|
/**
|
|
149
149
|
* `skipToken` is not allowed here — Suspense hooks cannot render a "disabled" state, so a query function
|
|
150
150
|
* must always be provided, unless a default query function has been defined.
|
|
@@ -159,14 +159,14 @@ interface UseSuspenseInfiniteQueryOptions<TQueryFnData = unknown, TError = Defau
|
|
|
159
159
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
160
160
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
161
161
|
*/
|
|
162
|
-
type UseBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
|
|
162
|
+
export type UseBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
|
|
163
163
|
/**
|
|
164
164
|
* The result of `useQuery`. Same as {@link UseBaseQueryResult}.
|
|
165
165
|
*
|
|
166
166
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
167
167
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
168
168
|
*/
|
|
169
|
-
type UseQueryResult<TData = unknown, TError = DefaultError> = UseBaseQueryResult<TData, TError>;
|
|
169
|
+
export type UseQueryResult<TData = unknown, TError = DefaultError> = UseBaseQueryResult<TData, TError>;
|
|
170
170
|
/**
|
|
171
171
|
* The result of `useSuspenseQuery`. Same as {@link DefinedUseQueryResult}, minus `isPlaceholderData` — always
|
|
172
172
|
* `false` on that type, so this drops the dead field rather than an active state.
|
|
@@ -174,7 +174,7 @@ type UseQueryResult<TData = unknown, TError = DefaultError> = UseBaseQueryResult
|
|
|
174
174
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
175
175
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
176
176
|
*/
|
|
177
|
-
type UseSuspenseQueryResult<TData = unknown, TError = DefaultError> = DistributiveOmit<DefinedQueryObserverResult<TData, TError>, 'isPlaceholderData'>;
|
|
177
|
+
export type UseSuspenseQueryResult<TData = unknown, TError = DefaultError> = DistributiveOmit<DefinedQueryObserverResult<TData, TError>, 'isPlaceholderData'>;
|
|
178
178
|
/**
|
|
179
179
|
* The result of `useQuery` when `initialData` is set, or of `useSuspenseQuery` before the `isPlaceholderData`
|
|
180
180
|
* omission — `data` is never `undefined` (unless a `select` changes `TData` to include `undefined`).
|
|
@@ -183,7 +183,7 @@ type UseSuspenseQueryResult<TData = unknown, TError = DefaultError> = Distributi
|
|
|
183
183
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
184
184
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
185
185
|
*/
|
|
186
|
-
type DefinedUseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
|
|
186
|
+
export type DefinedUseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
|
|
187
187
|
/**
|
|
188
188
|
* The result of `useInfiniteQuery` when `initialData` isn't set — `data` may be `undefined` while the query is
|
|
189
189
|
* `pending`. Re-exports {@link InfiniteQueryObserverResult} from `@tanstack/query-core`.
|
|
@@ -191,7 +191,7 @@ type DefinedUseQueryResult<TData = unknown, TError = DefaultError> = DefinedQuer
|
|
|
191
191
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
192
192
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
193
193
|
*/
|
|
194
|
-
type UseInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
|
|
194
|
+
export type UseInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
|
|
195
195
|
/**
|
|
196
196
|
* The result of `useInfiniteQuery` when `initialData` is set — `data` is never `undefined` (unless a
|
|
197
197
|
* `select` changes `TData` to include `undefined`). Re-exports {@link DefinedInfiniteQueryObserverResult}
|
|
@@ -200,7 +200,7 @@ type UseInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQu
|
|
|
200
200
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
201
201
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
202
202
|
*/
|
|
203
|
-
type DefinedUseInfiniteQueryResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError>;
|
|
203
|
+
export type DefinedUseInfiniteQueryResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError>;
|
|
204
204
|
/**
|
|
205
205
|
* The result of `useSuspenseInfiniteQuery`. Same as {@link DefinedUseInfiniteQueryResult}, minus
|
|
206
206
|
* `isPlaceholderData` — Suspense hooks never render placeholder data.
|
|
@@ -208,12 +208,12 @@ type DefinedUseInfiniteQueryResult<TData = unknown, TError = DefaultError> = Def
|
|
|
208
208
|
* @template TData - The type `data` ends up as after `select` runs.
|
|
209
209
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
210
210
|
*/
|
|
211
|
-
type UseSuspenseInfiniteQueryResult<TData = unknown, TError = DefaultError> = OmitKeyof<DefinedInfiniteQueryObserverResult<TData, TError>, 'isPlaceholderData'>;
|
|
211
|
+
export type UseSuspenseInfiniteQueryResult<TData = unknown, TError = DefaultError> = OmitKeyof<DefinedInfiniteQueryObserverResult<TData, TError>, 'isPlaceholderData'>;
|
|
212
212
|
/**
|
|
213
213
|
* {@link UseMutationOptions} with all type parameters set to `any`, useful when the specific types aren't
|
|
214
214
|
* relevant, e.g. when accepting options for any mutation in a helper function.
|
|
215
215
|
*/
|
|
216
|
-
type AnyUseMutationOptions = UseMutationOptions<any, any, any, any>;
|
|
216
|
+
export type AnyUseMutationOptions = UseMutationOptions<any, any, any, any>;
|
|
217
217
|
/**
|
|
218
218
|
* The options accepted by `useMutation`. Same as {@link MutationObserverOptions} from `@tanstack/query-core`,
|
|
219
219
|
* minus the internal `_defaulted` flag.
|
|
@@ -224,7 +224,7 @@ type AnyUseMutationOptions = UseMutationOptions<any, any, any, any>;
|
|
|
224
224
|
* @template TOnMutateResult - The type returned by `onMutate`, passed to `onSuccess`/`onError`/`onSettled` as
|
|
225
225
|
* their `onMutateResult` parameter — useful for optimistic-update rollback data.
|
|
226
226
|
*/
|
|
227
|
-
interface UseMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, '_defaulted'> {}
|
|
227
|
+
export interface UseMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, '_defaulted'> {}
|
|
228
228
|
/**
|
|
229
229
|
* The type of `mutate`, as returned by `useMutation`. Forwards the variables (and an optional per-call
|
|
230
230
|
* `onSuccess`/`onError`/`onSettled`) to the underlying `mutate` call. Fire-and-forget — errors are surfaced
|
|
@@ -236,7 +236,7 @@ interface UseMutationOptions<TData = unknown, TError = DefaultError, TVariables
|
|
|
236
236
|
* @template TOnMutateResult - The type returned by `onMutate`, passed to `onSuccess`/`onError`/`onSettled` as
|
|
237
237
|
* their `onMutateResult` parameter — useful for optimistic-update rollback data.
|
|
238
238
|
*/
|
|
239
|
-
type UseMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;
|
|
239
|
+
export type UseMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;
|
|
240
240
|
/**
|
|
241
241
|
* The type of `mutateAsync`, as returned by `useMutation`. Similar to {@link UseMutateFunction}, but returns a
|
|
242
242
|
* promise which can be awaited.
|
|
@@ -247,7 +247,7 @@ type UseMutateFunction<TData = unknown, TError = DefaultError, TVariables = void
|
|
|
247
247
|
* @template TOnMutateResult - The type returned by `onMutate`, passed to `onSuccess`/`onError`/`onSettled` as
|
|
248
248
|
* their `onMutateResult` parameter — useful for optimistic-update rollback data.
|
|
249
249
|
*/
|
|
250
|
-
type UseMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
|
|
250
|
+
export type UseMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
|
|
251
251
|
/**
|
|
252
252
|
* The result of `useMutation`. Same as {@link MutationObserverResult} from `@tanstack/query-core`, with
|
|
253
253
|
* `mutate` narrowed to the fire-and-forget {@link UseMutateFunction} signature, plus the added `mutateAsync`.
|
|
@@ -258,7 +258,7 @@ type UseMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables =
|
|
|
258
258
|
* @template TOnMutateResult - The type returned by `onMutate`, passed to `onSuccess`/`onError`/`onSettled` as
|
|
259
259
|
* their `onMutateResult` parameter — useful for optimistic-update rollback data.
|
|
260
260
|
*/
|
|
261
|
-
type UseBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>, {
|
|
261
|
+
export type UseBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>, {
|
|
262
262
|
mutate: UseMutateFunction<TData, TError, TVariables, TOnMutateResult>;
|
|
263
263
|
}> & {
|
|
264
264
|
/**
|
|
@@ -275,7 +275,6 @@ type UseBaseMutationResult<TData = unknown, TError = DefaultError, TVariables =
|
|
|
275
275
|
* @template TOnMutateResult - The type returned by `onMutate`, passed to `onSuccess`/`onError`/`onSettled` as
|
|
276
276
|
* their `onMutateResult` parameter — useful for optimistic-update rollback data.
|
|
277
277
|
*/
|
|
278
|
-
type UseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult>;
|
|
278
|
+
export type UseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult>;
|
|
279
279
|
//#endregion
|
|
280
|
-
export { AnyUseBaseQueryOptions, AnyUseInfiniteQueryOptions, AnyUseMutationOptions, AnyUseQueryOptions, AnyUseSuspenseInfiniteQueryOptions, AnyUseSuspenseQueryOptions, DefinedUseInfiniteQueryResult, DefinedUseQueryResult, UseBaseMutationResult, UseBaseQueryOptions, UseBaseQueryResult, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseMutateAsyncFunction, UseMutateFunction, UseMutationOptions, UseMutationResult, UsePrefetchInfiniteQueryOptions, UsePrefetchQueryOptions, UseQueryOptions, UseQueryResult, UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult };
|
|
281
280
|
//# sourceMappingURL=types.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.cts","names":[],"sources":["../../src/types.ts"],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"file":"types.d.cts","names":[],"sources":["../../src/types.ts"],"mappings":";;;;;;YA0BY,yBAAyB;;;;;;;;;;;;;iBAmBpB,oBACf,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,kBACrB,qBACR,cACA,QACA,OACA,YACA;;;;;;EAOA;;;;;;;;;;;;;;YAeU,wBACV,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,YAC3B,iBACF,oBAAoB,cAAc,QAAQ,OAAO,YAAY;;;;;EAO7D,UAAU,QACR,oBACE,cACA,QACA,OACA,cACA,uBAEF;;;;;;;;;;;;;;YAgBQ,gCACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,wBACE,iBACF,4BACE,cACA,QACA,OACA,WACA;;;;;EAQF,UAAU,QACR,4BACE,cACA,QACA,OACA,WACA,wBAEF;;;;;;YAQQ,qBAAqB;;;;;;;;;;;iBAWhB,gBACf,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,kBACrB,UACR,oBAAoB,cAAc,QAAQ,OAAO,cAAc;;;;;YAQrD,6BAA6B;;;;;;;;;;;;iBAiBxB,wBACf,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,kBACrB,UACR,gBAAgB,cAAc,QAAQ,OAAO;;;;;EAO7C,UAAU,QACR,gBAAgB,cAAc,QAAQ,OAAO,uBAC7C;;;;;;YAQQ,6BAA6B;;;;;;;;;;;;;iBAmBxB,wBACf,wBACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,8BACQ,UACR,6BACE,cACA,QACA,OACA,WACA;;;;;;EASF;;;;;;YAOU,qCACV;;;;;;;;;;;;;iBAae,gCACf,wBACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,8BACQ,UACR,wBAAwB,cAAc,QAAQ,OAAO,WAAW;;;;;EAOhE,UAAU,QACR,wBACE,cACA,QACA,OACA,WACA,wBAEF;;;;;;;;;;YAYQ,mBACV,iBACA,SAAS,gBACP,oBAAoB,OAAO;;;;;;;YAQnB,eACV,iBACA,SAAS,gBACP,mBAAmB,OAAO;;;;;;;;YASlB,uBACV,iBACA,SAAS,gBACP,iBACF,2BAA2B,OAAO;;;;;;;;;YAYxB,sBACV,iBACA,SAAS,gBACP,2BAA2B,OAAO;;;;;;;;YAS1B,uBACV,iBACA,SAAS,gBACP,4BAA4B,OAAO;;;;;;;;;YAU3B,8BACV,iBACA,SAAS,gBACP,mCAAmC,OAAO;;;;;;;;YASlC,+BACV,iBACA,SAAS,gBACP,UACF,mCAAmC,OAAO;;;;;YAQhC,wBAAwB;;;;;;;;;;;iBAWnB,mBACf,iBACA,SAAS,cACT,mBACA,mCACQ,UACR,wBAAwB,OAAO,QAAQ,YAAY;;;;;;;;;;;;YAezC,kBACV,iBACA,SAAS,cACT,mBACA,iCAEG,MAAM,WACP,eAAe,OAAO,QAAQ,YAAY;;;;;;;;;;;YAclC,uBACV,iBACA,SAAS,cACT,mBACA,6BACE,eAAe,OAAO,QAAQ,YAAY;;;;;;;;;;;YAYlC,sBACV,iBACA,SAAS,cACT,sBACA,6BACE,SACF,uBAAuB,OAAO,QAAQ,YAAY;EAChD,QAAQ,kBAAkB,OAAO,QAAQ,YAAY;;;;;EAKvD,aAAa,uBACX,OACA,QACA,YACA;;;;;;;;;;;YAaQ,kBACV,iBACA,SAAS,cACT,sBACA,6BACE,sBAAsB,OAAO,QAAQ,YAAY"}
|