Query Docs
AI/LLM: This documentation page is available in plain markdown format at/query/latest/docs/framework/vue/reference.md
@tanstack/vue-query
Classes#
- CancelledError
- InfiniteQueryObserver
- Mutation
- MutationCache
- MutationObserver
- QueriesObserver
- Query
- QueryCache
- QueryClient
- 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
- MutationState
- NotifyEvent
- OnlineManager
- QueriesObserverOptions
- QueryCacheConfig
- QueryClientConfig
- QueryExecuteOptions
- QueryFilters
- QueryObserverBaseResult
- QueryObserverLoadingErrorResult
- QueryObserverLoadingResult
- QueryObserverOptions
- QueryObserverPendingResult
- QueryObserverPlaceholderResult
- QueryObserverRefetchErrorResult
- QueryObserverSuccessResult
- QueryState
- RefetchOptions
- RefetchQueryFilters
- Register
- ResetOptions
- ResultOptions
- SetDataOptions
- TimeoutManager
Type Aliases#
- AnyDataTag
- DataTag
- dataTagErrorSymbol
- dataTagSymbol
- DefaultedInfiniteQueryObserverOptions
- DefaultedQueryObserverOptions
- DefaultError
- DefinedInfiniteQueryObserverResult
- DefinedInitialDataInfiniteOptions
- DefinedInitialQueryOptions
- DefinedInitialQueryOptionsWithDataTag
- DefinedQueryObserverResult
- DistributiveOmit
EnsureInfiniteQueryDataOptionsFetchInfiniteQueryOptions- FetchStatus
- GetNextPageParamFunction
- GetPreviousPageParamFunction
- InferDataFromTag
- InferErrorFromTag
- InfiniteQueryExecuteOptions
- InfiniteQueryObserverResult
- InitialDataFunction
- ManagedTimerId
- MutateFunction
- MutateFunctionRest
- MutationCacheNotifyEvent
- MutationFunction
- MutationFunctionContext
- MutationKey
- MutationMeta
- MutationObserverResult
- MutationOptions
- MutationResult
- MutationScope
- MutationStateOptions
- MutationStatus
- NetworkMode
- NonUndefinedGuard
- NotifyEventType
- NotifyOnChangeProps
- OmitKeyof
- Override
- PlaceholderDataFunction
- QueriesPlaceholderDataFunction
- QueryBooleanOption
- QueryCacheNotifyEvent
- QueryFunction
- QueryFunctionContext
- QueryKey
- QueryKeyHashFunction
- QueryKeyWithDataTag
- QueryMeta
- QueryObserverResult
- QueryOptions
- QueryPersister
- QueryStatus
- SkipToken
- StaleTime
- StaleTimeFunction
- ThrowOnError
- TimeoutCallback
- TimeoutProvider
- UndefinedInitialDataInfiniteOptions
- UndefinedInitialQueryOptions
- UndefinedInitialQueryOptionsWithDataTag
- UnsetMarker
- Updater
- UseInfiniteQueryOptions
- UseInfiniteQueryReturnType
- UseIsFetchingFilters
- UseIsMutatingFilters
- UseMutationOptions
- UseMutationReturnType
- UsePrefetchInfiniteQueryOptions
- UsePrefetchQueryOptions
- UseQueriesOptions
- UseQueriesResults
- UseQueryDefinedReturnType
- UseQueryOptions
- UseQueryReturnType
- VueQueryPluginOptions
- WithRequired
Variables#
- dataTagErrorSymbol
- dataTagSymbol
- defaultScheduler
- environmentManager
- focusManager
isServer- notifyManager
- onlineManager
- skipToken
- timeoutManager
- unsetMarker
- VueQueryPlugin
Functions#
- defaultShouldDehydrateMutation
- defaultShouldDehydrateQuery
- dehydrate
- dehydrateQuery
- experimental_streamedQuery
- hashKey
- hydrate
- infiniteQueryOptions
isCancelledError- keepPreviousData
- matchMutation
- matchQuery
- mutationOptions
- noop
- partialMatchKey
- queryOptions
- replaceEqualDeep
- shouldThrowError
- useInfiniteQuery
- useIsFetching
- useIsMutating
- useMutation
- useMutationState
- usePrefetchInfiniteQuery
- usePrefetchQuery
- useQueries
- useQuery
- useQueryClient