Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

index.md

315 lines12.9 KB

1---
2id: "@tanstack/solid-query"
3title: "@tanstack/solid-query"
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8## Classes
9​
10- [CancelledError](classes/CancelledError.md)
11- [InfiniteQueryObserver](classes/InfiniteQueryObserver.md)
12- [Mutation](classes/Mutation.md)
13- [MutationCache](classes/MutationCache.md)
14- [MutationObserver](classes/MutationObserver.md)
15- [QueriesObserver](classes/QueriesObserver.md)
16- [Query](classes/Query.md)
17- [QueryCache](classes/QueryCache.md)
18- [QueryClient](classes/QueryClient.md)
19- [QueryObserver](classes/QueryObserver.md)
20​
21## Interfaces
22​
23- [CancelOptions](interfaces/CancelOptions.md)
24- [DefaultOptions](interfaces/DefaultOptions.md)
25- [DehydratedState](interfaces/DehydratedState.md)
26- [DehydrateOptions](interfaces/DehydrateOptions.md)
27- [~~EnsureQueryDataOptions~~](interfaces/EnsureQueryDataOptions.md)
28- [FetchNextPageOptions](interfaces/FetchNextPageOptions.md)
29- [FetchPreviousPageOptions](interfaces/FetchPreviousPageOptions.md)
30- [~~FetchQueryOptions~~](interfaces/FetchQueryOptions.md)
31- [FocusManager](interfaces/FocusManager.md)
32- [HydrateOptions](interfaces/HydrateOptions.md)
33- [InfiniteData](interfaces/InfiniteData.md)
34- [InfiniteQueryObserverBaseResult](interfaces/InfiniteQueryObserverBaseResult.md)
35- [InfiniteQueryObserverLoadingErrorResult](interfaces/InfiniteQueryObserverLoadingErrorResult.md)
36- [InfiniteQueryObserverLoadingResult](interfaces/InfiniteQueryObserverLoadingResult.md)
37- [InfiniteQueryObserverOptions](interfaces/InfiniteQueryObserverOptions.md)
38- [InfiniteQueryObserverPendingResult](interfaces/InfiniteQueryObserverPendingResult.md)
39- [InfiniteQueryObserverPlaceholderResult](interfaces/InfiniteQueryObserverPlaceholderResult.md)
40- [InfiniteQueryObserverRefetchErrorResult](interfaces/InfiniteQueryObserverRefetchErrorResult.md)
41- [InfiniteQueryObserverSuccessResult](interfaces/InfiniteQueryObserverSuccessResult.md)
42- [InfiniteQueryOptions](interfaces/InfiniteQueryOptions.md)
43- [InfiniteQueryPageParamsOptions](interfaces/InfiniteQueryPageParamsOptions.md)
44- [InitialPageParam](interfaces/InitialPageParam.md)
45- [InvalidateOptions](interfaces/InvalidateOptions.md)
46- [InvalidateQueryFilters](interfaces/InvalidateQueryFilters.md)
47- [MutateOptions](interfaces/MutateOptions.md)
48- [MutationCacheConfig](interfaces/MutationCacheConfig.md)
49- [MutationFilters](interfaces/MutationFilters.md)
50- [MutationObserverBaseResult](interfaces/MutationObserverBaseResult.md)
51- [MutationObserverErrorResult](interfaces/MutationObserverErrorResult.md)
52- [MutationObserverIdleResult](interfaces/MutationObserverIdleResult.md)
53- [MutationObserverLoadingResult](interfaces/MutationObserverLoadingResult.md)
54- [MutationObserverOptions](interfaces/MutationObserverOptions.md)
55- [MutationObserverSuccessResult](interfaces/MutationObserverSuccessResult.md)
56- [MutationOptions](interfaces/MutationOptions.md)
57- [MutationState](interfaces/MutationState.md)
58- [NotifyEvent](interfaces/NotifyEvent.md)
59- [OnlineManager](interfaces/OnlineManager.md)
60- [QueriesObserverOptions](interfaces/QueriesObserverOptions.md)
61- [QueryCacheConfig](interfaces/QueryCacheConfig.md)
62- [QueryClientConfig](interfaces/QueryClientConfig.md)
63- [QueryExecuteOptions](interfaces/QueryExecuteOptions.md)
64- [QueryFilters](interfaces/QueryFilters.md)
65- [QueryObserverBaseResult](interfaces/QueryObserverBaseResult.md)
66- [QueryObserverLoadingErrorResult](interfaces/QueryObserverLoadingErrorResult.md)
67- [QueryObserverLoadingResult](interfaces/QueryObserverLoadingResult.md)
68- [QueryObserverOptions](interfaces/QueryObserverOptions.md)
69- [QueryObserverPendingResult](interfaces/QueryObserverPendingResult.md)
70- [QueryObserverPlaceholderResult](interfaces/QueryObserverPlaceholderResult.md)
71- [QueryObserverRefetchErrorResult](interfaces/QueryObserverRefetchErrorResult.md)
72- [QueryObserverSuccessResult](interfaces/QueryObserverSuccessResult.md)
73- [QueryOptions](interfaces/QueryOptions.md)
74- [QueryState](interfaces/QueryState.md)
75- [RefetchOptions](interfaces/RefetchOptions.md)
76- [RefetchQueryFilters](interfaces/RefetchQueryFilters.md)
77- [Register](interfaces/Register.md)
78- [ResetOptions](interfaces/ResetOptions.md)
79- [ResultOptions](interfaces/ResultOptions.md)
80- [SetDataOptions](interfaces/SetDataOptions.md)
81- [TimeoutManager](interfaces/TimeoutManager.md)
82- [UseBaseQueryOptions](interfaces/UseBaseQueryOptions.md)
83​
84## Type Aliases
85​
86- [AnyDataTag](type-aliases/AnyDataTag.md)
87- [DataTag](type-aliases/DataTag.md)
88- [dataTagErrorSymbol](type-aliases/dataTagErrorSymbol.md)
89- [dataTagSymbol](type-aliases/dataTagSymbol.md)
90- [DefaultedInfiniteQueryObserverOptions](type-aliases/DefaultedInfiniteQueryObserverOptions.md)
91- [DefaultedQueryObserverOptions](type-aliases/DefaultedQueryObserverOptions.md)
92- [DefaultError](type-aliases/DefaultError.md)
93- [DefinedInfiniteQueryObserverResult](type-aliases/DefinedInfiniteQueryObserverResult.md)
94- [DefinedInitialDataInfiniteOptions](type-aliases/DefinedInitialDataInfiniteOptions.md)
95- [DefinedInitialDataOptions](type-aliases/DefinedInitialDataOptions.md)
96- [DefinedQueryObserverResult](type-aliases/DefinedQueryObserverResult.md)
97- [DefinedUseBaseQueryResult](type-aliases/DefinedUseBaseQueryResult.md)
98- [DefinedUseInfiniteQueryResult](type-aliases/DefinedUseInfiniteQueryResult.md)
99- [DefinedUseQueryResult](type-aliases/DefinedUseQueryResult.md)
100- [DistributiveOmit](type-aliases/DistributiveOmit.md)
101- [~~EnsureInfiniteQueryDataOptions~~](type-aliases/EnsureInfiniteQueryDataOptions.md)
102- [~~FetchInfiniteQueryOptions~~](type-aliases/FetchInfiniteQueryOptions.md)
103- [FetchStatus](type-aliases/FetchStatus.md)
104- [GetNextPageParamFunction](type-aliases/GetNextPageParamFunction.md)
105- [GetPreviousPageParamFunction](type-aliases/GetPreviousPageParamFunction.md)
106- [InferDataFromTag](type-aliases/InferDataFromTag.md)
107- [InferErrorFromTag](type-aliases/InferErrorFromTag.md)
108- [InfiniteQueryExecuteOptions](type-aliases/InfiniteQueryExecuteOptions.md)
109- [InfiniteQueryObserverResult](type-aliases/InfiniteQueryObserverResult.md)
110- [InitialDataFunction](type-aliases/InitialDataFunction.md)
111- [ManagedTimerId](type-aliases/ManagedTimerId.md)
112- [MutateFunction](type-aliases/MutateFunction.md)
113- [MutateFunctionRest](type-aliases/MutateFunctionRest.md)
114- [MutationCacheNotifyEvent](type-aliases/MutationCacheNotifyEvent.md)
115- [MutationFunction](type-aliases/MutationFunction.md)
116- [MutationFunctionContext](type-aliases/MutationFunctionContext.md)
117- [MutationKey](type-aliases/MutationKey.md)
118- [MutationMeta](type-aliases/MutationMeta.md)
119- [MutationObserverResult](type-aliases/MutationObserverResult.md)
120- [MutationScope](type-aliases/MutationScope.md)
121- [MutationStatus](type-aliases/MutationStatus.md)
122- [NetworkMode](type-aliases/NetworkMode.md)
123- [NonUndefinedGuard](type-aliases/NonUndefinedGuard.md)
124- [NotifyEventType](type-aliases/NotifyEventType.md)
125- [NotifyOnChangeProps](type-aliases/NotifyOnChangeProps.md)
126- [OmitKeyof](type-aliases/OmitKeyof.md)
127- [Override](type-aliases/Override.md)
128- [PlaceholderDataFunction](type-aliases/PlaceholderDataFunction.md)
129- [QueriesPlaceholderDataFunction](type-aliases/QueriesPlaceholderDataFunction.md)
130- [QueryBooleanOption](type-aliases/QueryBooleanOption.md)
131- [QueryCacheNotifyEvent](type-aliases/QueryCacheNotifyEvent.md)
132- [QueryClientProviderProps](type-aliases/QueryClientProviderProps.md)
133- [QueryFunction](type-aliases/QueryFunction.md)
134- [QueryFunctionContext](type-aliases/QueryFunctionContext.md)
135- [QueryKey](type-aliases/QueryKey.md)
136- [QueryKeyHashFunction](type-aliases/QueryKeyHashFunction.md)
137- [QueryKeyWithDataTag](type-aliases/QueryKeyWithDataTag.md)
138- [QueryMeta](type-aliases/QueryMeta.md)
139- [QueryObserverResult](type-aliases/QueryObserverResult.md)
140- [QueryPersister](type-aliases/QueryPersister.md)
141- [QueryStatus](type-aliases/QueryStatus.md)
142- [SkipToken](type-aliases/SkipToken.md)
143- [StaleTime](type-aliases/StaleTime.md)
144- [StaleTimeFunction](type-aliases/StaleTimeFunction.md)
145- [ThrowOnError](type-aliases/ThrowOnError.md)
146- [TimeoutCallback](type-aliases/TimeoutCallback.md)
147- [TimeoutProvider](type-aliases/TimeoutProvider.md)
148- [UndefinedInitialDataInfiniteOptions](type-aliases/UndefinedInitialDataInfiniteOptions.md)
149- [UndefinedInitialDataOptions](type-aliases/UndefinedInitialDataOptions.md)
150- [UnsetMarker](type-aliases/UnsetMarker.md)
151- [Updater](type-aliases/Updater.md)
152- [UseBaseMutationResult](type-aliases/UseBaseMutationResult.md)
153- [UseBaseQueryResult](type-aliases/UseBaseQueryResult.md)
154- [UseInfiniteQueryOptions](type-aliases/UseInfiniteQueryOptions.md)
155- [UseInfiniteQueryResult](type-aliases/UseInfiniteQueryResult.md)
156- [UseMutateAsyncFunction](type-aliases/UseMutateAsyncFunction.md)
157- [UseMutateFunction](type-aliases/UseMutateFunction.md)
158- [UseMutationOptions](type-aliases/UseMutationOptions.md)
159- [UseMutationResult](type-aliases/UseMutationResult.md)
160- [UseQueryOptions](type-aliases/UseQueryOptions.md)
161- [UseQueryResult](type-aliases/UseQueryResult.md)
162- [WithRequired](type-aliases/WithRequired.md)
163​
164## Variables
165​
166- [createInfiniteQuery](variables/createInfiniteQuery.md)
167- [createMutation](variables/createMutation.md)
168- [createQueries](variables/createQueries.md)
169- [createQuery](variables/createQuery.md)
170- [dataTagErrorSymbol](variables/dataTagErrorSymbol.md)
171- [dataTagSymbol](variables/dataTagSymbol.md)
172- [defaultScheduler](variables/defaultScheduler.md)
173- [environmentManager](variables/environmentManager.md)
174- [focusManager](variables/focusManager.md)
175- [IsRestoringProvider](variables/IsRestoringProvider.md)
176- [~~isServer~~](variables/isServer.md)
177- [notifyManager](variables/notifyManager.md)
178- [onlineManager](variables/onlineManager.md)
179- [QueryClientContext](variables/QueryClientContext.md)
180- [skipToken](variables/skipToken.md)
181- [timeoutManager](variables/timeoutManager.md)
182- [unsetMarker](variables/unsetMarker.md)
183​
184## Functions
185​
186- [defaultShouldDehydrateMutation](functions/defaultShouldDehydrateMutation.md)
187- [defaultShouldDehydrateQuery](functions/defaultShouldDehydrateQuery.md)
188- [dehydrate](functions/dehydrate.md)
189- [dehydrateQuery](functions/dehydrateQuery.md)
190- [experimental\_streamedQuery](functions/experimental_streamedQuery.md)
191- [hashKey](functions/hashKey.md)
192- [hydrate](functions/hydrate.md)
193- [infiniteQueryOptions](functions/infiniteQueryOptions.md)
194- [~~isCancelledError~~](functions/isCancelledError.md)
195- [keepPreviousData](functions/keepPreviousData.md)
196- [matchMutation](functions/matchMutation.md)
197- [matchQuery](functions/matchQuery.md)
198- [mutationOptions](functions/mutationOptions.md)
199- [noop](functions/noop.md)
200- [partialMatchKey](functions/partialMatchKey.md)
201- [QueryClientProvider](functions/QueryClientProvider.md)
202- [queryOptions](functions/queryOptions.md)
203- [replaceEqualDeep](functions/replaceEqualDeep.md)
204- [shouldThrowError](functions/shouldThrowError.md)
205- [useInfiniteQuery](functions/useInfiniteQuery.md)
206- [useIsFetching](functions/useIsFetching.md)
207- [useIsMutating](functions/useIsMutating.md)
208- [useIsRestoring](functions/useIsRestoring.md)
209- [useMutation](functions/useMutation.md)
210- [useMutationState](functions/useMutationState.md)
211- [useQueries](functions/useQueries.md)
212- [useQuery](functions/useQuery.md)
213- [useQueryClient](functions/useQueryClient.md)
214​
215## References
216​
217### CreateBaseMutationResult
218​
219Renames and re-exports [UseBaseMutationResult](type-aliases/UseBaseMutationResult.md)
220​
221***
222​
223### CreateBaseQueryOptions
224​
225Renames and re-exports [UseBaseQueryOptions](interfaces/UseBaseQueryOptions.md)
226​
227***
228​
229### CreateBaseQueryResult
230​
231Renames and re-exports [UseBaseQueryResult](type-aliases/UseBaseQueryResult.md)
232​
233***
234​
235### CreateInfiniteQueryOptions
236​
237Renames and re-exports [UseInfiniteQueryOptions](type-aliases/UseInfiniteQueryOptions.md)
238​
239***
240​
241### CreateInfiniteQueryResult
242​
243Renames and re-exports [UseInfiniteQueryResult](type-aliases/UseInfiniteQueryResult.md)
244​
245***
246​
247### createIsFetching
248​
249Renames and re-exports [useIsFetching](functions/useIsFetching.md)
250​
251***
252​
253### createIsMutating
254​
255Renames and re-exports [useIsMutating](functions/useIsMutating.md)
256​
257***
258​
259### CreateMutateAsyncFunction
260​
261Renames and re-exports [UseMutateAsyncFunction](type-aliases/UseMutateAsyncFunction.md)
262​
263***
264​
265### CreateMutateFunction
266​
267Renames and re-exports [UseMutateFunction](type-aliases/UseMutateFunction.md)
268​
269***
270​
271### CreateMutationOptions
272​
273Renames and re-exports [UseMutationOptions](type-aliases/UseMutationOptions.md)
274​
275***
276​
277### CreateMutationResult
278​
279Renames and re-exports [UseMutationResult](type-aliases/UseMutationResult.md)
280​
281***
282​
283### createMutationState
284​
285Renames and re-exports [useMutationState](functions/useMutationState.md)
286​
287***
288​
289### CreateQueryOptions
290​
291Renames and re-exports [UseQueryOptions](type-aliases/UseQueryOptions.md)
292​
293***
294​
295### CreateQueryResult
296​
297Renames and re-exports [UseQueryResult](type-aliases/UseQueryResult.md)
298​
299***
300​
301### DefinedCreateBaseQueryResult
302​
303Renames and re-exports [DefinedUseBaseQueryResult](type-aliases/DefinedUseBaseQueryResult.md)
304​
305***
306​
307### DefinedCreateInfiniteQueryResult
308​
309Renames and re-exports [DefinedUseInfiniteQueryResult](type-aliases/DefinedUseInfiniteQueryResult.md)
310​
311***
312​
313### DefinedCreateQueryResult
314​
315Renames and re-exports [DefinedUseQueryResult](type-aliases/DefinedUseQueryResult.md)