@tanstack/solid-query 5.100.9 → 5.100.11

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/index.d.ts CHANGED
@@ -1,198 +1,228 @@
1
- export { DefinedUseBaseQueryResult } from './_tsup-dts-rollup.js';
2
- export { DefinedUseInfiniteQueryResult } from './_tsup-dts-rollup.js';
3
- export { DefinedUseQueryResult } from './_tsup-dts-rollup.js';
4
- export { InfiniteQueryOptions } from './_tsup-dts-rollup.js';
5
- export { MutationOptions } from './_tsup-dts-rollup.js';
6
- export { QueryOptions } from './_tsup-dts-rollup.js';
7
- export { UseBaseMutationResult } from './_tsup-dts-rollup.js';
8
- export { UseBaseQueryOptions } from './_tsup-dts-rollup.js';
9
- export { UseBaseQueryResult } from './_tsup-dts-rollup.js';
10
- export { UseInfiniteQueryOptions } from './_tsup-dts-rollup.js';
11
- export { UseInfiniteQueryResult } from './_tsup-dts-rollup.js';
12
- export { UseMutateAsyncFunction } from './_tsup-dts-rollup.js';
13
- export { UseMutateFunction } from './_tsup-dts-rollup.js';
14
- export { UseMutationOptions } from './_tsup-dts-rollup.js';
15
- export { UseMutationResult } from './_tsup-dts-rollup.js';
16
- export { UseQueryOptions } from './_tsup-dts-rollup.js';
17
- export { UseQueryResult } from './_tsup-dts-rollup.js';
18
- export { CreateBaseQueryOptions } from './_tsup-dts-rollup.js';
19
- export { CreateBaseQueryResult } from './_tsup-dts-rollup.js';
20
- export { CreateInfiniteQueryOptions } from './_tsup-dts-rollup.js';
21
- export { CreateInfiniteQueryResult } from './_tsup-dts-rollup.js';
22
- export { CreateMutateAsyncFunction } from './_tsup-dts-rollup.js';
23
- export { CreateMutateFunction } from './_tsup-dts-rollup.js';
24
- export { CreateMutationOptions } from './_tsup-dts-rollup.js';
25
- export { CreateMutationResult } from './_tsup-dts-rollup.js';
26
- export { CreateBaseMutationResult } from './_tsup-dts-rollup.js';
27
- export { CreateQueryOptions } from './_tsup-dts-rollup.js';
28
- export { CreateQueryResult } from './_tsup-dts-rollup.js';
29
- export { DefinedCreateBaseQueryResult } from './_tsup-dts-rollup.js';
30
- export { DefinedCreateInfiniteQueryResult } from './_tsup-dts-rollup.js';
31
- export { DefinedCreateQueryResult } from './_tsup-dts-rollup.js';
32
- export { QueryClient_alias_1 as QueryClient } from './_tsup-dts-rollup.js';
33
- export { QueryObserverOptions_alias_1 as QueryObserverOptions } from './_tsup-dts-rollup.js';
34
- export { DefaultOptions_alias_1 as DefaultOptions } from './_tsup-dts-rollup.js';
35
- export { QueryClientConfig_alias_1 as QueryClientConfig } from './_tsup-dts-rollup.js';
36
- export { InfiniteQueryObserverOptions_alias_1 as InfiniteQueryObserverOptions } from './_tsup-dts-rollup.js';
37
- export { useQuery } from './_tsup-dts-rollup.js';
38
- export { createQuery } from './_tsup-dts-rollup.js';
39
- export { queryOptions } from './_tsup-dts-rollup.js';
40
- export { DefinedInitialDataOptions } from './_tsup-dts-rollup.js';
41
- export { UndefinedInitialDataOptions } from './_tsup-dts-rollup.js';
42
- export { QueryClientContext_alias_1 as QueryClientContext } from './_tsup-dts-rollup.js';
43
- export { QueryClientProvider_alias_1 as QueryClientProvider } from './_tsup-dts-rollup.js';
44
- export { useQueryClient_alias_1 as useQueryClient } from './_tsup-dts-rollup.js';
45
- export { QueryClientProviderProps_alias_1 as QueryClientProviderProps } from './_tsup-dts-rollup.js';
46
- export { useIsFetching } from './_tsup-dts-rollup.js';
47
- export { createIsFetching } from './_tsup-dts-rollup.js';
48
- export { useInfiniteQuery } from './_tsup-dts-rollup.js';
49
- export { createInfiniteQuery } from './_tsup-dts-rollup.js';
50
- export { infiniteQueryOptions } from './_tsup-dts-rollup.js';
51
- export { DefinedInitialDataInfiniteOptions } from './_tsup-dts-rollup.js';
52
- export { UndefinedInitialDataInfiniteOptions } from './_tsup-dts-rollup.js';
53
- export { useMutation } from './_tsup-dts-rollup.js';
54
- export { mutationOptions } from './_tsup-dts-rollup.js';
55
- export { createMutation } from './_tsup-dts-rollup.js';
56
- export { useIsMutating } from './_tsup-dts-rollup.js';
57
- export { createIsMutating } from './_tsup-dts-rollup.js';
58
- export { useMutationState } from './_tsup-dts-rollup.js';
59
- export { createMutationState } from './_tsup-dts-rollup.js';
60
- export { useQueries } from './_tsup-dts-rollup.js';
61
- export { createQueries } from './_tsup-dts-rollup.js';
62
- export { useIsRestoring } from './_tsup-dts-rollup.js';
63
- export { IsRestoringProvider } from './_tsup-dts-rollup.js';
64
- export { focusManager } from './_tsup-dts-rollup.js';
65
- export { environmentManager } from './_tsup-dts-rollup.js';
66
- export { defaultShouldDehydrateMutation } from './_tsup-dts-rollup.js';
67
- export { defaultShouldDehydrateQuery } from './_tsup-dts-rollup.js';
68
- export { dehydrate } from './_tsup-dts-rollup.js';
69
- export { hydrate } from './_tsup-dts-rollup.js';
70
- export { InfiniteQueryObserver } from './_tsup-dts-rollup.js';
71
- export { MutationCache } from './_tsup-dts-rollup.js';
72
- export { MutationCacheNotifyEvent } from './_tsup-dts-rollup.js';
73
- export { MutationObserver } from './_tsup-dts-rollup.js';
74
- export { defaultScheduler } from './_tsup-dts-rollup.js';
75
- export { notifyManager } from './_tsup-dts-rollup.js';
76
- export { onlineManager } from './_tsup-dts-rollup.js';
77
- export { QueriesObserver } from './_tsup-dts-rollup.js';
78
- export { QueryCache } from './_tsup-dts-rollup.js';
79
- export { QueryCacheNotifyEvent } from './_tsup-dts-rollup.js';
80
- export { QueryObserver } from './_tsup-dts-rollup.js';
81
- export { CancelledError } from './_tsup-dts-rollup.js';
82
- export { isCancelledError } from './_tsup-dts-rollup.js';
83
- export { timeoutManager } from './_tsup-dts-rollup.js';
84
- export { ManagedTimerId } from './_tsup-dts-rollup.js';
85
- export { TimeoutCallback } from './_tsup-dts-rollup.js';
86
- export { TimeoutProvider } from './_tsup-dts-rollup.js';
87
- export { hashKey } from './_tsup-dts-rollup.js';
88
- export { isServer } from './_tsup-dts-rollup.js';
89
- export { keepPreviousData } from './_tsup-dts-rollup.js';
90
- export { matchMutation } from './_tsup-dts-rollup.js';
91
- export { matchQuery } from './_tsup-dts-rollup.js';
92
- export { noop } from './_tsup-dts-rollup.js';
93
- export { partialMatchKey } from './_tsup-dts-rollup.js';
94
- export { replaceEqualDeep } from './_tsup-dts-rollup.js';
95
- export { shouldThrowError } from './_tsup-dts-rollup.js';
96
- export { skipToken } from './_tsup-dts-rollup.js';
97
- export { MutationFilters } from './_tsup-dts-rollup.js';
98
- export { QueryFilters } from './_tsup-dts-rollup.js';
99
- export { SkipToken } from './_tsup-dts-rollup.js';
100
- export { Updater } from './_tsup-dts-rollup.js';
101
- export { experimental_streamedQuery } from './_tsup-dts-rollup.js';
102
- export { DehydratedState } from './_tsup-dts-rollup.js';
103
- export { DehydrateOptions } from './_tsup-dts-rollup.js';
104
- export { HydrateOptions } from './_tsup-dts-rollup.js';
105
- export { Mutation } from './_tsup-dts-rollup.js';
106
- export { MutationState } from './_tsup-dts-rollup.js';
107
- export { QueriesObserverOptions } from './_tsup-dts-rollup.js';
108
- export { Query } from './_tsup-dts-rollup.js';
109
- export { QueryState } from './_tsup-dts-rollup.js';
110
- export { NonUndefinedGuard } from './_tsup-dts-rollup.js';
111
- export { DistributiveOmit } from './_tsup-dts-rollup.js';
112
- export { OmitKeyof } from './_tsup-dts-rollup.js';
113
- export { Override } from './_tsup-dts-rollup.js';
114
- export { NoInfer } from './_tsup-dts-rollup.js';
115
- export { Register } from './_tsup-dts-rollup.js';
116
- export { DefaultError } from './_tsup-dts-rollup.js';
117
- export { QueryKey } from './_tsup-dts-rollup.js';
118
- export { dataTagSymbol } from './_tsup-dts-rollup.js';
119
- export { dataTagErrorSymbol } from './_tsup-dts-rollup.js';
120
- export { unsetMarker } from './_tsup-dts-rollup.js';
121
- export { UnsetMarker } from './_tsup-dts-rollup.js';
122
- export { AnyDataTag } from './_tsup-dts-rollup.js';
123
- export { DataTag } from './_tsup-dts-rollup.js';
124
- export { InferDataFromTag } from './_tsup-dts-rollup.js';
125
- export { InferErrorFromTag } from './_tsup-dts-rollup.js';
126
- export { QueryFunction } from './_tsup-dts-rollup.js';
127
- export { StaleTime } from './_tsup-dts-rollup.js';
128
- export { StaleTimeFunction } from './_tsup-dts-rollup.js';
129
- export { QueryBooleanOption } from './_tsup-dts-rollup.js';
130
- export { QueryPersister } from './_tsup-dts-rollup.js';
131
- export { QueryFunctionContext } from './_tsup-dts-rollup.js';
132
- export { InitialDataFunction } from './_tsup-dts-rollup.js';
133
- export { PlaceholderDataFunction } from './_tsup-dts-rollup.js';
134
- export { QueriesPlaceholderDataFunction } from './_tsup-dts-rollup.js';
135
- export { QueryKeyHashFunction } from './_tsup-dts-rollup.js';
136
- export { GetPreviousPageParamFunction } from './_tsup-dts-rollup.js';
137
- export { GetNextPageParamFunction } from './_tsup-dts-rollup.js';
138
- export { InfiniteData } from './_tsup-dts-rollup.js';
139
- export { QueryMeta } from './_tsup-dts-rollup.js';
140
- export { NetworkMode } from './_tsup-dts-rollup.js';
141
- export { NotifyOnChangeProps } from './_tsup-dts-rollup.js';
142
- export { InitialPageParam } from './_tsup-dts-rollup.js';
143
- export { InfiniteQueryPageParamsOptions } from './_tsup-dts-rollup.js';
144
- export { ThrowOnError } from './_tsup-dts-rollup.js';
145
- export { WithRequired } from './_tsup-dts-rollup.js';
146
- export { DefaultedQueryObserverOptions } from './_tsup-dts-rollup.js';
147
- export { DefaultedInfiniteQueryObserverOptions } from './_tsup-dts-rollup.js';
148
- export { FetchQueryOptions } from './_tsup-dts-rollup.js';
149
- export { EnsureQueryDataOptions } from './_tsup-dts-rollup.js';
150
- export { EnsureInfiniteQueryDataOptions } from './_tsup-dts-rollup.js';
151
- export { FetchInfiniteQueryOptions } from './_tsup-dts-rollup.js';
152
- export { ResultOptions } from './_tsup-dts-rollup.js';
153
- export { RefetchOptions } from './_tsup-dts-rollup.js';
154
- export { InvalidateQueryFilters } from './_tsup-dts-rollup.js';
155
- export { RefetchQueryFilters } from './_tsup-dts-rollup.js';
156
- export { InvalidateOptions } from './_tsup-dts-rollup.js';
157
- export { ResetOptions } from './_tsup-dts-rollup.js';
158
- export { FetchNextPageOptions } from './_tsup-dts-rollup.js';
159
- export { FetchPreviousPageOptions } from './_tsup-dts-rollup.js';
160
- export { QueryStatus } from './_tsup-dts-rollup.js';
161
- export { FetchStatus } from './_tsup-dts-rollup.js';
162
- export { QueryObserverBaseResult } from './_tsup-dts-rollup.js';
163
- export { QueryObserverPendingResult } from './_tsup-dts-rollup.js';
164
- export { QueryObserverLoadingResult } from './_tsup-dts-rollup.js';
165
- export { QueryObserverLoadingErrorResult } from './_tsup-dts-rollup.js';
166
- export { QueryObserverRefetchErrorResult } from './_tsup-dts-rollup.js';
167
- export { QueryObserverSuccessResult } from './_tsup-dts-rollup.js';
168
- export { QueryObserverPlaceholderResult } from './_tsup-dts-rollup.js';
169
- export { DefinedQueryObserverResult } from './_tsup-dts-rollup.js';
170
- export { QueryObserverResult } from './_tsup-dts-rollup.js';
171
- export { InfiniteQueryObserverBaseResult } from './_tsup-dts-rollup.js';
172
- export { InfiniteQueryObserverPendingResult } from './_tsup-dts-rollup.js';
173
- export { InfiniteQueryObserverLoadingResult } from './_tsup-dts-rollup.js';
174
- export { InfiniteQueryObserverLoadingErrorResult } from './_tsup-dts-rollup.js';
175
- export { InfiniteQueryObserverRefetchErrorResult } from './_tsup-dts-rollup.js';
176
- export { InfiniteQueryObserverSuccessResult } from './_tsup-dts-rollup.js';
177
- export { InfiniteQueryObserverPlaceholderResult } from './_tsup-dts-rollup.js';
178
- export { DefinedInfiniteQueryObserverResult } from './_tsup-dts-rollup.js';
179
- export { InfiniteQueryObserverResult } from './_tsup-dts-rollup.js';
180
- export { MutationKey } from './_tsup-dts-rollup.js';
181
- export { MutationStatus } from './_tsup-dts-rollup.js';
182
- export { MutationScope } from './_tsup-dts-rollup.js';
183
- export { MutationMeta } from './_tsup-dts-rollup.js';
184
- export { MutationFunctionContext } from './_tsup-dts-rollup.js';
185
- export { MutationFunction } from './_tsup-dts-rollup.js';
186
- export { MutationObserverOptions } from './_tsup-dts-rollup.js';
187
- export { MutateOptions } from './_tsup-dts-rollup.js';
188
- export { MutateFunction } from './_tsup-dts-rollup.js';
189
- export { MutationObserverBaseResult } from './_tsup-dts-rollup.js';
190
- export { MutationObserverIdleResult } from './_tsup-dts-rollup.js';
191
- export { MutationObserverLoadingResult } from './_tsup-dts-rollup.js';
192
- export { MutationObserverErrorResult } from './_tsup-dts-rollup.js';
193
- export { MutationObserverSuccessResult } from './_tsup-dts-rollup.js';
194
- export { MutationObserverResult } from './_tsup-dts-rollup.js';
195
- export { CancelOptions } from './_tsup-dts-rollup.js';
196
- export { SetDataOptions } from './_tsup-dts-rollup.js';
197
- export { NotifyEventType } from './_tsup-dts-rollup.js';
198
- export { NotifyEvent } from './_tsup-dts-rollup.js';
1
+ import { DefaultError, QueryKey, OmitKeyof, QueryObserverOptions as QueryObserverOptions$1, InfiniteQueryObserverOptions as InfiniteQueryObserverOptions$1, DefaultOptions as DefaultOptions$1, QueryClient as QueryClient$1, QueryClientConfig as QueryClientConfig$1, Override, MutationObserverResult, MutateFunction, QueryObserverResult, InfiniteQueryObserverResult, MutationObserverOptions, DefinedQueryObserverResult, DefinedInfiniteQueryObserverResult, DataTag, InfiniteData, NonUndefinedGuard, QueryFunction, ThrowOnError, QueriesPlaceholderDataFunction, QueryFilters, WithRequired, MutationFilters, MutationState, Mutation } from '@tanstack/query-core';
2
+ export * from '@tanstack/query-core';
3
+ import * as solid_js from 'solid-js';
4
+ import { Accessor, JSX } from 'solid-js';
5
+
6
+ interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends OmitKeyof<QueryObserverOptions$1<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'structuralSharing'> {
7
+ /**
8
+ * Set this to a reconciliation key to enable reconciliation between query results.
9
+ * Set this to `false` to disable reconciliation between query results.
10
+ * Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom reconciliation logic.
11
+ * Defaults reconciliation to false.
12
+ */
13
+ reconcile?: string | false | ((oldData: TData | undefined, newData: TData) => TData);
14
+ }
15
+ interface InfiniteQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions$1<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'structuralSharing'> {
16
+ /**
17
+ * Set this to a reconciliation key to enable reconciliation between query results.
18
+ * Set this to `false` to disable reconciliation between query results.
19
+ * Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom reconciliation logic.
20
+ * Defaults reconciliation to false.
21
+ */
22
+ reconcile?: string | false | ((oldData: TData | undefined, newData: TData) => TData);
23
+ }
24
+ interface DefaultOptions<TError = DefaultError> extends DefaultOptions$1<TError> {
25
+ queries?: OmitKeyof<QueryObserverOptions<unknown, TError>, 'queryKey'>;
26
+ }
27
+ interface QueryClientConfig extends QueryClientConfig$1 {
28
+ defaultOptions?: DefaultOptions;
29
+ }
30
+ declare class QueryClient extends QueryClient$1 {
31
+ constructor(config?: QueryClientConfig);
32
+ }
33
+
34
+ interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
35
+ /**
36
+ * Only applicable while rendering queries on the server with streaming.
37
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
38
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
39
+ * Defaults to `false`.
40
+ */
41
+ deferStream?: boolean;
42
+ /**
43
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
44
+ * The `data` property on useQuery is a SolidJS resource and will automatically suspend when the data is loading.
45
+ * Setting `suspense` to `false` will be a no-op.
46
+ */
47
+ suspense?: boolean;
48
+ }
49
+ interface QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
50
+ }
51
+ type UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<QueryOptions<TQueryFnData, TError, TData, TQueryKey>>;
52
+ type UseBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
53
+ type UseQueryResult<TData = unknown, TError = DefaultError> = UseBaseQueryResult<TData, TError>;
54
+ type DefinedUseBaseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
55
+ type DefinedUseQueryResult<TData = unknown, TError = DefaultError> = DefinedUseBaseQueryResult<TData, TError>;
56
+ interface InfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryKey' | 'suspense'> {
57
+ queryKey: TQueryKey;
58
+ /**
59
+ * Only applicable while rendering queries on the server with streaming.
60
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
61
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
62
+ * Defaults to `false`.
63
+ */
64
+ deferStream?: boolean;
65
+ /**
66
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
67
+ * The `data` property on useInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
68
+ * Setting `suspense` to `false` will be a no-op.
69
+ */
70
+ suspense?: boolean;
71
+ }
72
+ type UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>>;
73
+ type UseInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
74
+ type DefinedUseInfiniteQueryResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError>;
75
+ interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, '_defaulted'> {
76
+ }
77
+ type UseMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = Accessor<MutationOptions<TData, TError, TVariables, TOnMutateResult>>;
78
+ type UseMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;
79
+ type UseMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
80
+ type UseBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>, {
81
+ mutate: UseMutateFunction<TData, TError, TVariables, TOnMutateResult>;
82
+ }> & {
83
+ mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult>;
84
+ };
85
+ type UseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult>;
86
+
87
+ type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<QueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
88
+ initialData?: undefined;
89
+ }>;
90
+ type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<QueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
91
+ initialData: TQueryFnData | (() => TQueryFnData);
92
+ }>;
93
+ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: ReturnType<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>>): ReturnType<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & {
94
+ queryKey: DataTag<TQueryKey, TQueryFnData, TError>;
95
+ };
96
+ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: ReturnType<DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>>): ReturnType<DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & {
97
+ queryKey: DataTag<TQueryKey, TQueryFnData, TError>;
98
+ };
99
+
100
+ declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): UseQueryResult<TData, TError>;
101
+ declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): DefinedUseQueryResult<TData, TError>;
102
+
103
+ type UndefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
104
+ initialData?: undefined;
105
+ }>;
106
+ type DefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
107
+ initialData: NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>> | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>);
108
+ }>;
109
+ declare function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: ReturnType<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>>): ReturnType<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & {
110
+ queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
111
+ };
112
+ declare function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>>): ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & {
113
+ queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
114
+ };
115
+
116
+ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): DefinedUseInfiniteQueryResult<TData, TError>;
117
+ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): UseInfiniteQueryResult<TData, TError>;
118
+
119
+ declare function useMutation<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(options: UseMutationOptions<TData, TError, TVariables, TOnMutateResult>, queryClient?: Accessor<QueryClient>): UseMutationResult<TData, TError, TVariables, TOnMutateResult>;
120
+
121
+ type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<QueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
122
+ placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
123
+ /**
124
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
125
+ * The `data` property on useQueries is a plain object and not a SolidJS Resource.
126
+ * It will not suspend when the data is loading.
127
+ * Setting `suspense` to `true` will be a no-op.
128
+ */
129
+ suspense?: boolean;
130
+ };
131
+ type MAXIMUM_DEPTH = 20;
132
+ type SkipTokenForUseQueries = symbol;
133
+ type GetOptions<T> = T extends {
134
+ queryFnData: infer TQueryFnData;
135
+ error?: infer TError;
136
+ data: infer TData;
137
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends {
138
+ queryFnData: infer TQueryFnData;
139
+ error?: infer TError;
140
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends {
141
+ data: infer TData;
142
+ error?: infer TError;
143
+ } ? UseQueryOptionsForUseQueries<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseQueryOptionsForUseQueries<TQueryFnData> : T extends {
144
+ queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> | SkipTokenForUseQueries;
145
+ select?: (data: any) => infer TData;
146
+ throwOnError?: ThrowOnError<any, infer TError, any, any>;
147
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : UseQueryOptionsForUseQueries;
148
+ type GetResults<T> = T extends {
149
+ queryFnData: any;
150
+ error?: infer TError;
151
+ data: infer TData;
152
+ } ? UseQueryResult<TData, TError> : T extends {
153
+ queryFnData: infer TQueryFnData;
154
+ error?: infer TError;
155
+ } ? UseQueryResult<TQueryFnData, TError> : T extends {
156
+ data: infer TData;
157
+ error?: infer TError;
158
+ } ? UseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseQueryResult<TQueryFnData> : T extends {
159
+ queryFn?: QueryFunction<infer TQueryFnData, any> | SkipTokenForUseQueries;
160
+ select?: (data: any) => infer TData;
161
+ throwOnError?: ThrowOnError<any, infer TError, any, any>;
162
+ } ? UseQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : UseQueryResult;
163
+ /**
164
+ * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
165
+ */
166
+ type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryOptionsForUseQueries> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[
167
+ ...Tail
168
+ ], [
169
+ ...TResult,
170
+ GetOptions<Head>
171
+ ], [
172
+ ...TDepth,
173
+ 1
174
+ ]> : ReadonlyArray<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
175
+ /**
176
+ * QueriesResults reducer recursively maps type param to results
177
+ */
178
+ type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[
179
+ ...Tail
180
+ ], [
181
+ ...TResult,
182
+ GetResults<Head>
183
+ ], [
184
+ ...TDepth,
185
+ 1
186
+ ]> : {
187
+ [K in keyof T]: GetResults<T[K]>;
188
+ };
189
+ declare function useQueries<T extends Array<any>, TCombinedResult extends QueriesResults<T> = QueriesResults<T>>(queriesOptions: Accessor<{
190
+ queries: readonly [...QueriesOptions<T>] | readonly [...{
191
+ [K in keyof T]: GetOptions<T[K]>;
192
+ }];
193
+ combine?: (result: QueriesResults<T>) => TCombinedResult;
194
+ }>, queryClient?: Accessor<QueryClient>): TCombinedResult;
195
+
196
+ declare const QueryClientContext: solid_js.Context<(() => QueryClient) | undefined>;
197
+ declare const useQueryClient: (queryClient?: QueryClient) => QueryClient;
198
+ type QueryClientProviderProps = {
199
+ client: QueryClient;
200
+ children?: JSX.Element;
201
+ };
202
+ declare const QueryClientProvider: (props: QueryClientProviderProps) => JSX.Element;
203
+
204
+ declare function useIsFetching(filters?: Accessor<QueryFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
205
+
206
+ declare function mutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>): WithRequired<MutationOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>;
207
+ declare function mutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(options: Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>): Omit<MutationOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>;
208
+
209
+ declare function useIsMutating(filters?: Accessor<MutationFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
210
+
211
+ type MutationStateOptions<TResult = MutationState> = {
212
+ filters?: MutationFilters;
213
+ select?: (mutation: Mutation) => TResult;
214
+ };
215
+ declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
216
+
217
+ declare const useIsRestoring: () => Accessor<boolean>;
218
+ declare const IsRestoringProvider: solid_js.ContextProviderComponent<Accessor<boolean>>;
219
+
220
+ declare const createQuery: typeof useQuery;
221
+
222
+ declare const createInfiniteQuery: typeof useInfiniteQuery;
223
+
224
+ declare const createMutation: typeof useMutation;
225
+
226
+ declare const createQueries: typeof useQueries;
227
+
228
+ export { type UseBaseMutationResult as CreateBaseMutationResult, type UseBaseQueryOptions as CreateBaseQueryOptions, type UseBaseQueryResult as CreateBaseQueryResult, type UseInfiniteQueryOptions as CreateInfiniteQueryOptions, type UseInfiniteQueryResult as CreateInfiniteQueryResult, type UseMutateAsyncFunction as CreateMutateAsyncFunction, type UseMutateFunction as CreateMutateFunction, type UseMutationOptions as CreateMutationOptions, type UseMutationResult as CreateMutationResult, type UseQueryOptions as CreateQueryOptions, type UseQueryResult as CreateQueryResult, type DefaultOptions, type DefinedUseBaseQueryResult as DefinedCreateBaseQueryResult, type DefinedUseInfiniteQueryResult as DefinedCreateInfiniteQueryResult, type DefinedUseQueryResult as DefinedCreateQueryResult, type DefinedInitialDataInfiniteOptions, type DefinedInitialDataOptions, type DefinedUseBaseQueryResult, type DefinedUseInfiniteQueryResult, type DefinedUseQueryResult, type InfiniteQueryObserverOptions, type InfiniteQueryOptions, IsRestoringProvider, type MutationOptions, QueryClient, type QueryClientConfig, QueryClientContext, QueryClientProvider, type QueryClientProviderProps, type QueryObserverOptions, type QueryOptions, type UndefinedInitialDataInfiniteOptions, type UndefinedInitialDataOptions, type UseBaseMutationResult, type UseBaseQueryOptions, type UseBaseQueryResult, type UseInfiniteQueryOptions, type UseInfiniteQueryResult, type UseMutateAsyncFunction, type UseMutateFunction, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, createInfiniteQuery, useIsFetching as createIsFetching, useIsMutating as createIsMutating, createMutation, useMutationState as createMutationState, createQueries, createQuery, infiniteQueryOptions, mutationOptions, queryOptions, useInfiniteQuery, useIsFetching, useIsMutating, useIsRestoring, useMutation, useMutationState, useQueries, useQuery, useQueryClient };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/solid-query",
3
- "version": "5.100.9",
3
+ "version": "5.100.11",
4
4
  "description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
5
5
  "author": "tannerlinsley",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "!src/__tests__"
47
47
  ],
48
48
  "dependencies": {
49
- "@tanstack/query-core": "5.100.9"
49
+ "@tanstack/query-core": "5.100.11"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@solidjs/testing-library": "^0.8.10",