Open History to see the last commit
1---
2id: "@tanstack/lit-query"
3title: "@tanstack/lit-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- [QueryClientProvider](classes/QueryClientProvider.md)
20- [QueryObserver](classes/QueryObserver.md)
21β
22## Interfaces
23β
24- [CancelOptions](interfaces/CancelOptions.md)
25- [DefaultOptions](interfaces/DefaultOptions.md)
26- [DehydratedState](interfaces/DehydratedState.md)
27- [DehydrateOptions](interfaces/DehydrateOptions.md)
28- [~~EnsureQueryDataOptions~~](interfaces/EnsureQueryDataOptions.md)
29- [FetchNextPageOptions](interfaces/FetchNextPageOptions.md)
30- [FetchPreviousPageOptions](interfaces/FetchPreviousPageOptions.md)
31- [~~FetchQueryOptions~~](interfaces/FetchQueryOptions.md)
32- [FocusManager](interfaces/FocusManager.md)
33- [HydrateOptions](interfaces/HydrateOptions.md)
34- [InfiniteData](interfaces/InfiniteData.md)
35- [InfiniteQueryObserverBaseResult](interfaces/InfiniteQueryObserverBaseResult.md)
36- [InfiniteQueryObserverLoadingErrorResult](interfaces/InfiniteQueryObserverLoadingErrorResult.md)
37- [InfiniteQueryObserverLoadingResult](interfaces/InfiniteQueryObserverLoadingResult.md)
38- [InfiniteQueryObserverOptions](interfaces/InfiniteQueryObserverOptions.md)
39- [InfiniteQueryObserverPendingResult](interfaces/InfiniteQueryObserverPendingResult.md)
40- [InfiniteQueryObserverPlaceholderResult](interfaces/InfiniteQueryObserverPlaceholderResult.md)
41- [InfiniteQueryObserverRefetchErrorResult](interfaces/InfiniteQueryObserverRefetchErrorResult.md)
42- [InfiniteQueryObserverSuccessResult](interfaces/InfiniteQueryObserverSuccessResult.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β
83## Type Aliases
84β
85- [Accessor](type-aliases/Accessor.md)
86- [AnyDataTag](type-aliases/AnyDataTag.md)
87- [CreateInfiniteQueryOptions](type-aliases/CreateInfiniteQueryOptions.md)
88- [CreateMutationOptions](type-aliases/CreateMutationOptions.md)
89- [CreateQueriesControllerOptions](type-aliases/CreateQueriesControllerOptions.md)
90- [CreateQueriesInput](type-aliases/CreateQueriesInput.md)
91- [CreateQueryOptions](type-aliases/CreateQueryOptions.md)
92- [DataTag](type-aliases/DataTag.md)
93- [dataTagErrorSymbol](type-aliases/dataTagErrorSymbol.md)
94- [dataTagSymbol](type-aliases/dataTagSymbol.md)
95- [DefaultedInfiniteQueryObserverOptions](type-aliases/DefaultedInfiniteQueryObserverOptions.md)
96- [DefaultedQueryObserverOptions](type-aliases/DefaultedQueryObserverOptions.md)
97- [DefaultError](type-aliases/DefaultError.md)
98- [DefinedInfiniteQueryObserverResult](type-aliases/DefinedInfiniteQueryObserverResult.md)
99- [DefinedInitialDataOptions](type-aliases/DefinedInitialDataOptions.md)
100- [DefinedQueryObserverResult](type-aliases/DefinedQueryObserverResult.md)
101- [DistributiveOmit](type-aliases/DistributiveOmit.md)
102- [~~EnsureInfiniteQueryDataOptions~~](type-aliases/EnsureInfiniteQueryDataOptions.md)
103- [~~FetchInfiniteQueryOptions~~](type-aliases/FetchInfiniteQueryOptions.md)
104- [FetchStatus](type-aliases/FetchStatus.md)
105- [GetNextPageParamFunction](type-aliases/GetNextPageParamFunction.md)
106- [GetPreviousPageParamFunction](type-aliases/GetPreviousPageParamFunction.md)
107- [InferDataFromTag](type-aliases/InferDataFromTag.md)
108- [InferErrorFromTag](type-aliases/InferErrorFromTag.md)
109- [InfiniteQueryControllerOptions](type-aliases/InfiniteQueryControllerOptions.md)
110- [InfiniteQueryExecuteOptions](type-aliases/InfiniteQueryExecuteOptions.md)
111- [InfiniteQueryObserverResult](type-aliases/InfiniteQueryObserverResult.md)
112- [InfiniteQueryResultAccessor](type-aliases/InfiniteQueryResultAccessor.md)
113- [InitialDataFunction](type-aliases/InitialDataFunction.md)
114- [IsFetchingAccessor](type-aliases/IsFetchingAccessor.md)
115- [IsMutatingAccessor](type-aliases/IsMutatingAccessor.md)
116- [ManagedTimerId](type-aliases/ManagedTimerId.md)
117- [MutateFunction](type-aliases/MutateFunction.md)
118- [MutateFunctionRest](type-aliases/MutateFunctionRest.md)
119- [MutationCacheNotifyEvent](type-aliases/MutationCacheNotifyEvent.md)
120- [MutationControllerOptions](type-aliases/MutationControllerOptions.md)
121- [MutationControllerResult](type-aliases/MutationControllerResult.md)
122- [MutationFunction](type-aliases/MutationFunction.md)
123- [MutationFunctionContext](type-aliases/MutationFunctionContext.md)
124- [MutationKey](type-aliases/MutationKey.md)
125- [MutationMeta](type-aliases/MutationMeta.md)
126- [MutationObserverResult](type-aliases/MutationObserverResult.md)
127- [MutationResultAccessor](type-aliases/MutationResultAccessor.md)
128- [MutationScope](type-aliases/MutationScope.md)
129- [MutationStateAccessor](type-aliases/MutationStateAccessor.md)
130- [MutationStateOptions](type-aliases/MutationStateOptions.md)
131- [MutationStatus](type-aliases/MutationStatus.md)
132- [NetworkMode](type-aliases/NetworkMode.md)
133- [NonUndefinedGuard](type-aliases/NonUndefinedGuard.md)
134- [NotifyEventType](type-aliases/NotifyEventType.md)
135- [NotifyOnChangeProps](type-aliases/NotifyOnChangeProps.md)
136- [OmitKeyof](type-aliases/OmitKeyof.md)
137- [Override](type-aliases/Override.md)
138- [PlaceholderDataFunction](type-aliases/PlaceholderDataFunction.md)
139- [QueriesControllerOptions](type-aliases/QueriesControllerOptions.md)
140- [QueriesPlaceholderDataFunction](type-aliases/QueriesPlaceholderDataFunction.md)
141- [QueriesResultAccessor](type-aliases/QueriesResultAccessor.md)
142- [QueryBooleanOption](type-aliases/QueryBooleanOption.md)
143- [QueryCacheNotifyEvent](type-aliases/QueryCacheNotifyEvent.md)
144- [QueryControllerOptions](type-aliases/QueryControllerOptions.md)
145- [QueryControllerResult](type-aliases/QueryControllerResult.md)
146- [QueryFunction](type-aliases/QueryFunction.md)
147- [QueryFunctionContext](type-aliases/QueryFunctionContext.md)
148- [QueryKey](type-aliases/QueryKey.md)
149- [QueryKeyHashFunction](type-aliases/QueryKeyHashFunction.md)
150- [QueryKeyWithDataTag](type-aliases/QueryKeyWithDataTag.md)
151- [QueryMeta](type-aliases/QueryMeta.md)
152- [QueryObserverResult](type-aliases/QueryObserverResult.md)
153- [QueryPersister](type-aliases/QueryPersister.md)
154- [QueryResultAccessor](type-aliases/QueryResultAccessor.md)
155- [QueryStatus](type-aliases/QueryStatus.md)
156- [SkipToken](type-aliases/SkipToken.md)
157- [StaleTime](type-aliases/StaleTime.md)
158- [StaleTimeFunction](type-aliases/StaleTimeFunction.md)
159- [ThrowOnError](type-aliases/ThrowOnError.md)
160- [TimeoutCallback](type-aliases/TimeoutCallback.md)
161- [TimeoutProvider](type-aliases/TimeoutProvider.md)
162- [UndefinedInitialDataOptions](type-aliases/UndefinedInitialDataOptions.md)
163- [UnsetMarker](type-aliases/UnsetMarker.md)
164- [UnusedSkipTokenOptions](type-aliases/UnusedSkipTokenOptions.md)
165- [Updater](type-aliases/Updater.md)
166- [ValueAccessor](type-aliases/ValueAccessor.md)
167- [WithRequired](type-aliases/WithRequired.md)
168β
169## Variables
170β
171- [dataTagErrorSymbol](variables/dataTagErrorSymbol.md)
172- [dataTagSymbol](variables/dataTagSymbol.md)
173- [defaultScheduler](variables/defaultScheduler.md)
174- [environmentManager](variables/environmentManager.md)
175- [focusManager](variables/focusManager.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- [createInfiniteQueryController](functions/createInfiniteQueryController.md)
187- [createMutationController](functions/createMutationController.md)
188- [createQueriesController](functions/createQueriesController.md)
189- [createQueryController](functions/createQueryController.md)
190- [defaultShouldDehydrateMutation](functions/defaultShouldDehydrateMutation.md)
191- [defaultShouldDehydrateQuery](functions/defaultShouldDehydrateQuery.md)
192- [dehydrate](functions/dehydrate.md)
193- [dehydrateQuery](functions/dehydrateQuery.md)
194- [experimental\_streamedQuery](functions/experimental_streamedQuery.md)
195- [getDefaultQueryClient](functions/getDefaultQueryClient.md)
196- [hashKey](functions/hashKey.md)
197- [hydrate](functions/hydrate.md)
198- [infiniteQueryOptions](functions/infiniteQueryOptions.md)
199- [~~isCancelledError~~](functions/isCancelledError.md)
200- [keepPreviousData](functions/keepPreviousData.md)
201- [matchMutation](functions/matchMutation.md)
202- [matchQuery](functions/matchQuery.md)
203- [mutationOptions](functions/mutationOptions.md)
204- [noop](functions/noop.md)
205- [partialMatchKey](functions/partialMatchKey.md)
206- [queryOptions](functions/queryOptions.md)
207- [registerDefaultQueryClient](functions/registerDefaultQueryClient.md)
208- [replaceEqualDeep](functions/replaceEqualDeep.md)
209- [resolveQueryClient](functions/resolveQueryClient.md)
210- [shouldThrowError](functions/shouldThrowError.md)
211- [unregisterDefaultQueryClient](functions/unregisterDefaultQueryClient.md)
212- [useIsFetching](functions/useIsFetching.md)
213- [useIsMutating](functions/useIsMutating.md)
214- [useMutationState](functions/useMutationState.md)
215- [useQueryClient](functions/useQueryClient.md)