Query Docs
Getting Started
AI/LLM: This documentation page is available in plain markdown format at/query/latest/docs/framework/lit/reference.md
@tanstack/lit-query
Classes#
- CancelledError
- InfiniteQueryObserver
- Mutation
- MutationCache
- MutationObserver
- QueriesObserver
- Query
- QueryCache
- QueryClient
- QueryClientProvider
- QueryObserver
Interfaces#
- CancelOptions
- DefaultOptions
- DehydratedState
- DehydrateOptions
EnsureQueryDataOptions- FetchNextPageOptions
- FetchPreviousPageOptions
FetchQueryOptions- FocusManager
- HydrateOptions
- InfiniteData
- InfiniteQueryObserverBaseResult
- InfiniteQueryObserverLoadingErrorResult
- InfiniteQueryObserverLoadingResult
- InfiniteQueryObserverOptions
- InfiniteQueryObserverPendingResult
- InfiniteQueryObserverPlaceholderResult
- InfiniteQueryObserverRefetchErrorResult
- InfiniteQueryObserverSuccessResult
- InfiniteQueryPageParamsOptions
- InitialPageParam
- InvalidateOptions
- InvalidateQueryFilters
- MutateOptions
- MutationCacheConfig
- MutationFilters
- MutationObserverBaseResult
- MutationObserverErrorResult
- MutationObserverIdleResult
- MutationObserverLoadingResult
- MutationObserverOptions
- MutationObserverSuccessResult
- MutationOptions
- MutationState
- NotifyEvent
- OnlineManager
- QueriesObserverOptions
- QueryCacheConfig
- QueryClientConfig
- QueryExecuteOptions
- QueryFilters
- QueryObserverBaseResult
- QueryObserverLoadingErrorResult
- QueryObserverLoadingResult
- QueryObserverOptions
- QueryObserverPendingResult
- QueryObserverPlaceholderResult
- QueryObserverRefetchErrorResult
- QueryObserverSuccessResult
- QueryOptions
- QueryState
- RefetchOptions
- RefetchQueryFilters
- Register
- ResetOptions
- ResultOptions
- SetDataOptions
- TimeoutManager
Type Aliases#
- Accessor
- AnyDataTag
- CreateInfiniteQueryOptions
- CreateMutationOptions
- CreateQueriesControllerOptions
- CreateQueriesInput
- CreateQueryOptions
- DataTag
- dataTagErrorSymbol
- dataTagSymbol
- DefaultedInfiniteQueryObserverOptions
- DefaultedQueryObserverOptions
- DefaultError
- DefinedInfiniteQueryObserverResult
- DefinedInitialDataOptions
- DefinedQueryObserverResult
- DistributiveOmit
EnsureInfiniteQueryDataOptionsFetchInfiniteQueryOptions- FetchStatus
- GetNextPageParamFunction
- GetPreviousPageParamFunction
- InferDataFromTag
- InferErrorFromTag
- InfiniteQueryControllerOptions
- InfiniteQueryExecuteOptions
- InfiniteQueryObserverResult
- InfiniteQueryResultAccessor
- InitialDataFunction
- IsFetchingAccessor
- IsMutatingAccessor
- ManagedTimerId
- MutateFunction
- MutateFunctionRest
- MutationCacheNotifyEvent
- MutationControllerOptions
- MutationControllerResult
- MutationFunction
- MutationFunctionContext
- MutationKey
- MutationMeta
- MutationObserverResult
- MutationResultAccessor
- MutationScope
- MutationStateAccessor
- MutationStateOptions
- MutationStatus
- NetworkMode
- NonUndefinedGuard
- NotifyEventType
- NotifyOnChangeProps
- OmitKeyof
- Override
- PlaceholderDataFunction
- QueriesControllerOptions
- QueriesPlaceholderDataFunction
- QueriesResultAccessor
- QueryBooleanOption
- QueryCacheNotifyEvent
- QueryControllerOptions
- QueryControllerResult
- QueryFunction
- QueryFunctionContext
- QueryKey
- QueryKeyHashFunction
- QueryKeyWithDataTag
- QueryMeta
- QueryObserverResult
- QueryPersister
- QueryResultAccessor
- QueryStatus
- SkipToken
- StaleTime
- StaleTimeFunction
- ThrowOnError
- TimeoutCallback
- TimeoutProvider
- UndefinedInitialDataOptions
- UnsetMarker
- UnusedSkipTokenOptions
- Updater
- ValueAccessor
- WithRequired
Variables#
- dataTagErrorSymbol
- dataTagSymbol
- defaultScheduler
- environmentManager
- focusManager
isServer- notifyManager
- onlineManager
- queryClientContext
- skipToken
- timeoutManager
- unsetMarker
Functions#
- createInfiniteQueryController
- createMutationController
- createQueriesController
- createQueryController
- defaultShouldDehydrateMutation
- defaultShouldDehydrateQuery
- dehydrate
- dehydrateQuery
- experimental_streamedQuery
- getDefaultQueryClient
- hashKey
- hydrate
- infiniteQueryOptions
isCancelledError- keepPreviousData
- matchMutation
- matchQuery
- mutationOptions
- noop
- partialMatchKey
- queryOptions
- registerDefaultQueryClient
- replaceEqualDeep
- resolveQueryClient
- shouldThrowError
- unregisterDefaultQueryClient
- useIsFetching
- useIsMutating
- useMutationState
- useQueryClient