Libraries
Framework
Start
Router
Data & State
Query
DB
Store
AI
UI & UX
Table
Charts
Form
Hotkeys
Markdown
Highlight
Performance
Virtual
Pacer
Tooling
Devtools
Config
CLI
Intent
Browse all libraries
Blog
Blog & Release Notes
About
YouTube
The official TanStack channel.
Workshops
Live sessions from the maintainers.
Release Notes
The latest releases and changelog.
Community
Channels
Discord
Real-time community support.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Showcase
Teams building with TanStack.
Tools
Tools
Application Starter
Alpha
Generate TanStack app starters.
Builder
Alpha
Build and share TanStack projects.
Stats
NPM and ecosystem usage data.
Merch
View all
Support
Support
Support Overview
Find the right support path.
Partners
Companies supporting TanStack.
OSS Sponsors
Sponsors keeping TanStack open source.
Enterprise Support
Private consulting and expert support.
Contact
Get in touch with the TanStack team.
About
Ethos
How we approach open source.
Tenets
The values that shape TanStack libraries.
Design System
Logos, tokens, and UI components.
Search
Ask AI
Libraries
Blog
Community
Tools
Merch
Support
Search
Ask AI
Sign In
Back
Query Docs
Lit
v5
Latest
Search...
K
Home
Get Started
Guides
API
Examples
API Reference
Lit Reference
Classes / CancelledError
Classes / InfiniteQueryObserver
Classes / Mutation
Classes / MutationCache
Classes / MutationObserver
Classes / QueriesObserver
Classes / Query
Classes / QueryCache
Classes / QueryClient
Classes / QueryClientProvider
Classes / QueryObserver
Functions / createInfiniteQueryController
Functions / createMutationController
Functions / createQueriesController
Functions / createQueryController
Functions / defaultShouldDehydrateMutation
Functions / defaultShouldDehydrateQuery
Functions / dehydrate
Functions / dehydrateQuery
Functions / experimental_streamedQuery
Functions / hashKey
Functions / hydrate
Functions / infiniteQueryOptions
Functions / isCancelledError
Functions / keepPreviousData
Functions / matchMutation
Functions / matchQuery
Functions / mutationOptions
Functions / noop
Functions / partialMatchKey
Functions / queryOptions
Functions / replaceEqualDeep
Functions / shouldThrowError
Functions / useIsFetching
Functions / useIsMutating
Functions / useMutationState
Functions / useQueryClient
Context / queryClientContext
Context / getDefaultQueryClient
Context / registerDefaultQueryClient
Context / unregisterDefaultQueryClient
Context / resolveQueryClient
Interfaces / CancelOptions
Interfaces / DefaultOptions
Interfaces / DehydrateOptions
Interfaces / DehydratedState
Interfaces / EnsureQueryDataOptions
Interfaces / FetchNextPageOptions
Interfaces / FetchPreviousPageOptions
Interfaces / FetchQueryOptions
Interfaces / FocusManager
Interfaces / HydrateOptions
Interfaces / InfiniteData
Interfaces / InfiniteQueryObserverBaseResult
Interfaces / InfiniteQueryObserverLoadingErrorResult
Interfaces / InfiniteQueryObserverLoadingResult
Interfaces / InfiniteQueryObserverOptions
Interfaces / InfiniteQueryObserverPendingResult
Interfaces / InfiniteQueryObserverPlaceholderResult
Interfaces / InfiniteQueryObserverRefetchErrorResult
Interfaces / InfiniteQueryObserverSuccessResult
Interfaces / InfiniteQueryPageParamsOptions
Interfaces / InitialPageParam
Interfaces / InvalidateOptions
Interfaces / InvalidateQueryFilters
Interfaces / MutateOptions
Interfaces / MutationCacheConfig
Interfaces / MutationFilters
Interfaces / MutationObserverBaseResult
Interfaces / MutationObserverErrorResult
Interfaces / MutationObserverIdleResult
Interfaces / MutationObserverLoadingResult
Interfaces / MutationObserverOptions
Interfaces / MutationObserverSuccessResult
Interfaces / MutationOptions
Interfaces / MutationState
Interfaces / NotifyEvent
Interfaces / OnlineManager
Interfaces / QueriesObserverOptions
Interfaces / QueryCacheConfig
Interfaces / QueryClientConfig
Interfaces / QueryExecuteOptions
Interfaces / QueryFilters
Interfaces / QueryObserverBaseResult
Interfaces / QueryObserverLoadingErrorResult
Interfaces / QueryObserverLoadingResult
Interfaces / QueryObserverOptions
Interfaces / QueryObserverPendingResult
Interfaces / QueryObserverPlaceholderResult
Interfaces / QueryObserverRefetchErrorResult
Interfaces / QueryObserverSuccessResult
Interfaces / QueryOptions
Interfaces / QueryState
Interfaces / RefetchOptions
Interfaces / RefetchQueryFilters
Interfaces / Register
Interfaces / ResetOptions
Interfaces / ResultOptions
Interfaces / SetDataOptions
Interfaces / TimeoutManager
Types / Accessor
Types / AnyDataTag
Types / CreateInfiniteQueryOptions
Types / CreateMutationOptions
Types / CreateQueriesControllerOptions
Types / CreateQueriesInput
Types / CreateQueryOptions
Types / DataTag
Types / DefaultError
Types / DefaultedInfiniteQueryObserverOptions
Types / DefaultedQueryObserverOptions
Types / DefinedInfiniteQueryObserverResult
Types / DefinedInitialDataOptions
Types / DefinedQueryObserverResult
Types / DistributiveOmit
Types / EnsureInfiniteQueryDataOptions
Types / FetchInfiniteQueryOptions
Types / FetchStatus
Types / GetNextPageParamFunction
Types / GetPreviousPageParamFunction
Types / InferDataFromTag
Types / InferErrorFromTag
Types / InfiniteQueryControllerOptions
Types / InfiniteQueryExecuteOptions
Types / InfiniteQueryObserverResult
Types / InfiniteQueryResultAccessor
Types / InitialDataFunction
Types / IsFetchingAccessor
Types / IsMutatingAccessor
Types / ManagedTimerId
Types / MutateFunction
Types / MutateFunctionRest
Types / MutationCacheNotifyEvent
Types / MutationControllerOptions
Types / MutationControllerResult
Types / MutationFunction
Types / MutationFunctionContext
Types / MutationKey
Types / MutationMeta
Types / MutationObserverResult
Types / MutationResultAccessor
Types / MutationScope
Types / MutationStateAccessor
Types / MutationStateOptions
Types / MutationStatus
Types / NetworkMode
Types / NonUndefinedGuard
Types / NotifyEventType
Types / NotifyOnChangeProps
Types / OmitKeyof
Types / Override
Types / PlaceholderDataFunction
Types / QueriesControllerOptions
Types / QueriesPlaceholderDataFunction
Types / QueriesResultAccessor
Types / QueryBooleanOption
Types / QueryCacheNotifyEvent
Types / QueryControllerOptions
Types / QueryControllerResult
Types / QueryFunction
Types / QueryFunctionContext
Types / QueryKey
Types / QueryKeyHashFunction
Types / QueryKeyWithDataTag
Types / QueryMeta
Types / QueryObserverResult
Types / QueryPersister
Types / QueryResultAccessor
Types / QueryStatus
Types / SkipToken
Types / StaleTime
Types / StaleTimeFunction
Types / ThrowOnError
Types / TimeoutCallback
Types / TimeoutProvider
Types / UndefinedInitialDataOptions
Types / UnsetMarker
Types / UnusedSkipTokenOptions
Types / Updater
Types / ValueAccessor
Types / WithRequired
Types / dataTagErrorSymbol
Types / dataTagSymbol
Variables / dataTagErrorSymbol
Variables / dataTagSymbol
Variables / defaultScheduler
Variables / environmentManager
Variables / focusManager
Variables / isServer
Variables / notifyManager
Variables / onlineManager
Variables / skipToken
Variables / timeoutManager
Variables / unsetMarker
Query
Menu
Menu
Home
Get Started
Guides
API
Examples
Lit
v5
Latest
API Reference
Lit Reference
Classes / CancelledError
Classes / InfiniteQueryObserver
Classes / Mutation
Classes / MutationCache
Classes / MutationObserver
Classes / QueriesObserver
Classes / Query
Classes / QueryCache
Classes / QueryClient
Classes / QueryClientProvider
Classes / QueryObserver
Functions / createInfiniteQueryController
Functions / createMutationController
Functions / createQueriesController
Functions / createQueryController
Functions / defaultShouldDehydrateMutation
Functions / defaultShouldDehydrateQuery
Functions / dehydrate
Functions / dehydrateQuery
Functions / experimental_streamedQuery
Functions / hashKey
Functions / hydrate
Functions / infiniteQueryOptions
Functions / isCancelledError
Functions / keepPreviousData
Functions / matchMutation
Functions / matchQuery
Functions / mutationOptions
Functions / noop
Functions / partialMatchKey
Functions / queryOptions
Functions / replaceEqualDeep
Functions / shouldThrowError
Functions / useIsFetching
Functions / useIsMutating
Functions / useMutationState
Functions / useQueryClient
Context / queryClientContext
Context / getDefaultQueryClient
Context / registerDefaultQueryClient
Context / unregisterDefaultQueryClient
Context / resolveQueryClient
Interfaces / CancelOptions
Interfaces / DefaultOptions
Interfaces / DehydrateOptions
Interfaces / DehydratedState
Interfaces / EnsureQueryDataOptions
Interfaces / FetchNextPageOptions
Interfaces / FetchPreviousPageOptions
Interfaces / FetchQueryOptions
Interfaces / FocusManager
Interfaces / HydrateOptions
Interfaces / InfiniteData
Interfaces / InfiniteQueryObserverBaseResult
Interfaces / InfiniteQueryObserverLoadingErrorResult
Interfaces / InfiniteQueryObserverLoadingResult
Interfaces / InfiniteQueryObserverOptions
Interfaces / InfiniteQueryObserverPendingResult
Interfaces / InfiniteQueryObserverPlaceholderResult
Interfaces / InfiniteQueryObserverRefetchErrorResult
Interfaces / InfiniteQueryObserverSuccessResult
Interfaces / InfiniteQueryPageParamsOptions
Interfaces / InitialPageParam
Interfaces / InvalidateOptions
Interfaces / InvalidateQueryFilters
Interfaces / MutateOptions
Interfaces / MutationCacheConfig
Interfaces / MutationFilters
Interfaces / MutationObserverBaseResult
Interfaces / MutationObserverErrorResult
Interfaces / MutationObserverIdleResult
Interfaces / MutationObserverLoadingResult
Interfaces / MutationObserverOptions
Interfaces / MutationObserverSuccessResult
Interfaces / MutationOptions
Interfaces / MutationState
Interfaces / NotifyEvent
Interfaces / OnlineManager
Interfaces / QueriesObserverOptions
Interfaces / QueryCacheConfig
Interfaces / QueryClientConfig
Interfaces / QueryExecuteOptions
Interfaces / QueryFilters
Interfaces / QueryObserverBaseResult
Interfaces / QueryObserverLoadingErrorResult
Interfaces / QueryObserverLoadingResult
Interfaces / QueryObserverOptions
Interfaces / QueryObserverPendingResult
Interfaces / QueryObserverPlaceholderResult
Interfaces / QueryObserverRefetchErrorResult
Interfaces / QueryObserverSuccessResult
Interfaces / QueryOptions
Interfaces / QueryState
Interfaces / RefetchOptions
Interfaces / RefetchQueryFilters
Interfaces / Register
Interfaces / ResetOptions
Interfaces / ResultOptions
Interfaces / SetDataOptions
Interfaces / TimeoutManager
Types / Accessor
Types / AnyDataTag
Types / CreateInfiniteQueryOptions
Types / CreateMutationOptions
Types / CreateQueriesControllerOptions
Types / CreateQueriesInput
Types / CreateQueryOptions
Types / DataTag
Types / DefaultError
Types / DefaultedInfiniteQueryObserverOptions
Types / DefaultedQueryObserverOptions
Types / DefinedInfiniteQueryObserverResult
Types / DefinedInitialDataOptions
Types / DefinedQueryObserverResult
Types / DistributiveOmit
Types / EnsureInfiniteQueryDataOptions
Types / FetchInfiniteQueryOptions
Types / FetchStatus
Types / GetNextPageParamFunction
Types / GetPreviousPageParamFunction
Types / InferDataFromTag
Types / InferErrorFromTag
Types / InfiniteQueryControllerOptions
Types / InfiniteQueryExecuteOptions
Types / InfiniteQueryObserverResult
Types / InfiniteQueryResultAccessor
Types / InitialDataFunction
Types / IsFetchingAccessor
Types / IsMutatingAccessor
Types / ManagedTimerId
Types / MutateFunction
Types / MutateFunctionRest
Types / MutationCacheNotifyEvent
Types / MutationControllerOptions
Types / MutationControllerResult
Types / MutationFunction
Types / MutationFunctionContext
Types / MutationKey
Types / MutationMeta
Types / MutationObserverResult
Types / MutationResultAccessor
Types / MutationScope
Types / MutationStateAccessor
Types / MutationStateOptions
Types / MutationStatus
Types / NetworkMode
Types / NonUndefinedGuard
Types / NotifyEventType
Types / NotifyOnChangeProps
Types / OmitKeyof
Types / Override
Types / PlaceholderDataFunction
Types / QueriesControllerOptions
Types / QueriesPlaceholderDataFunction
Types / QueriesResultAccessor
Types / QueryBooleanOption
Types / QueryCacheNotifyEvent
Types / QueryControllerOptions
Types / QueryControllerResult
Types / QueryFunction
Types / QueryFunctionContext
Types / QueryKey
Types / QueryKeyHashFunction
Types / QueryKeyWithDataTag
Types / QueryMeta
Types / QueryObserverResult
Types / QueryPersister
Types / QueryResultAccessor
Types / QueryStatus
Types / SkipToken
Types / StaleTime
Types / StaleTimeFunction
Types / ThrowOnError
Types / TimeoutCallback
Types / TimeoutProvider
Types / UndefinedInitialDataOptions
Types / UnsetMarker
Types / UnusedSkipTokenOptions
Types / Updater
Types / ValueAccessor
Types / WithRequired
Types / dataTagErrorSymbol
Types / dataTagSymbol
Variables / dataTagErrorSymbol
Variables / dataTagSymbol
Variables / defaultScheduler
Variables / environmentManager
Variables / focusManager
Variables / isServer
Variables / notifyManager
Variables / onlineManager
Variables / skipToken
Variables / timeoutManager
Variables / unsetMarker
AI/LLM: This documentation page is available in plain markdown format at/query/latest/docs/framework/lit/reference/index.md
API Reference
On this page
@tanstack/lit-query
Copy page
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
EnsureInfiniteQueryDataOptions
FetchInfiniteQueryOptions
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
Edit on GitHub
Next
Classes / CancelledError
On this page
Classes
Interfaces
Type Aliases
Variables
Functions
Partners
Become a Partner
Gold
Silver
Bronze
Latest Posts