--- id: "@tanstack/preact-query" title: "@tanstack/preact-query" --- ## Classes - [CancelledError](classes/CancelledError.md) - [InfiniteQueryObserver](classes/InfiniteQueryObserver.md) - [Mutation](classes/Mutation.md) - [MutationCache](classes/MutationCache.md) - [MutationObserver](classes/MutationObserver.md) - [QueriesObserver](classes/QueriesObserver.md) - [Query](classes/Query.md) - [QueryCache](classes/QueryCache.md) - [QueryClient](classes/QueryClient.md) - [QueryObserver](classes/QueryObserver.md) ## Interfaces - [CancelOptions](interfaces/CancelOptions.md) - [DefaultOptions](interfaces/DefaultOptions.md) - [DehydratedState](interfaces/DehydratedState.md) - [DehydrateOptions](interfaces/DehydrateOptions.md) - [~~EnsureQueryDataOptions~~](interfaces/EnsureQueryDataOptions.md) - [FetchNextPageOptions](interfaces/FetchNextPageOptions.md) - [FetchPreviousPageOptions](interfaces/FetchPreviousPageOptions.md) - [~~FetchQueryOptions~~](interfaces/FetchQueryOptions.md) - [FocusManager](interfaces/FocusManager.md) - [HydrateOptions](interfaces/HydrateOptions.md) - [HydrationBoundaryProps](interfaces/HydrationBoundaryProps.md) - [InfiniteData](interfaces/InfiniteData.md) - [InfiniteQueryObserverBaseResult](interfaces/InfiniteQueryObserverBaseResult.md) - [InfiniteQueryObserverLoadingErrorResult](interfaces/InfiniteQueryObserverLoadingErrorResult.md) - [InfiniteQueryObserverLoadingResult](interfaces/InfiniteQueryObserverLoadingResult.md) - [InfiniteQueryObserverOptions](interfaces/InfiniteQueryObserverOptions.md) - [InfiniteQueryObserverPendingResult](interfaces/InfiniteQueryObserverPendingResult.md) - [InfiniteQueryObserverPlaceholderResult](interfaces/InfiniteQueryObserverPlaceholderResult.md) - [InfiniteQueryObserverRefetchErrorResult](interfaces/InfiniteQueryObserverRefetchErrorResult.md) - [InfiniteQueryObserverSuccessResult](interfaces/InfiniteQueryObserverSuccessResult.md) - [InfiniteQueryPageParamsOptions](interfaces/InfiniteQueryPageParamsOptions.md) - [InitialPageParam](interfaces/InitialPageParam.md) - [InvalidateOptions](interfaces/InvalidateOptions.md) - [InvalidateQueryFilters](interfaces/InvalidateQueryFilters.md) - [MutateOptions](interfaces/MutateOptions.md) - [MutationCacheConfig](interfaces/MutationCacheConfig.md) - [MutationFilters](interfaces/MutationFilters.md) - [MutationObserverBaseResult](interfaces/MutationObserverBaseResult.md) - [MutationObserverErrorResult](interfaces/MutationObserverErrorResult.md) - [MutationObserverIdleResult](interfaces/MutationObserverIdleResult.md) - [MutationObserverLoadingResult](interfaces/MutationObserverLoadingResult.md) - [MutationObserverOptions](interfaces/MutationObserverOptions.md) - [MutationObserverSuccessResult](interfaces/MutationObserverSuccessResult.md) - [MutationOptions](interfaces/MutationOptions.md) - [MutationState](interfaces/MutationState.md) - [NotifyEvent](interfaces/NotifyEvent.md) - [OnlineManager](interfaces/OnlineManager.md) - [QueriesObserverOptions](interfaces/QueriesObserverOptions.md) - [QueryCacheConfig](interfaces/QueryCacheConfig.md) - [QueryClientConfig](interfaces/QueryClientConfig.md) - [QueryErrorResetBoundaryProps](interfaces/QueryErrorResetBoundaryProps.md) - [QueryExecuteOptions](interfaces/QueryExecuteOptions.md) - [QueryFilters](interfaces/QueryFilters.md) - [QueryObserverBaseResult](interfaces/QueryObserverBaseResult.md) - [QueryObserverLoadingErrorResult](interfaces/QueryObserverLoadingErrorResult.md) - [QueryObserverLoadingResult](interfaces/QueryObserverLoadingResult.md) - [QueryObserverOptions](interfaces/QueryObserverOptions.md) - [QueryObserverPendingResult](interfaces/QueryObserverPendingResult.md) - [QueryObserverPlaceholderResult](interfaces/QueryObserverPlaceholderResult.md) - [QueryObserverRefetchErrorResult](interfaces/QueryObserverRefetchErrorResult.md) - [QueryObserverSuccessResult](interfaces/QueryObserverSuccessResult.md) - [QueryOptions](interfaces/QueryOptions.md) - [QueryState](interfaces/QueryState.md) - [RefetchOptions](interfaces/RefetchOptions.md) - [RefetchQueryFilters](interfaces/RefetchQueryFilters.md) - [Register](interfaces/Register.md) - [ResetOptions](interfaces/ResetOptions.md) - [ResultOptions](interfaces/ResultOptions.md) - [SetDataOptions](interfaces/SetDataOptions.md) - [TimeoutManager](interfaces/TimeoutManager.md) - [UseBaseQueryOptions](interfaces/UseBaseQueryOptions.md) - [UseInfiniteQueryOptions](interfaces/UseInfiniteQueryOptions.md) - [UseMutationOptions](interfaces/UseMutationOptions.md) - [UseQueryOptions](interfaces/UseQueryOptions.md) - [UseSuspenseInfiniteQueryOptions](interfaces/UseSuspenseInfiniteQueryOptions.md) - [UseSuspenseQueryOptions](interfaces/UseSuspenseQueryOptions.md) ## Type Aliases - [AnyDataTag](type-aliases/AnyDataTag.md) - [AnyUseBaseQueryOptions](type-aliases/AnyUseBaseQueryOptions.md) - [AnyUseInfiniteQueryOptions](type-aliases/AnyUseInfiniteQueryOptions.md) - [AnyUseMutationOptions](type-aliases/AnyUseMutationOptions.md) - [AnyUseQueryOptions](type-aliases/AnyUseQueryOptions.md) - [AnyUseSuspenseInfiniteQueryOptions](type-aliases/AnyUseSuspenseInfiniteQueryOptions.md) - [AnyUseSuspenseQueryOptions](type-aliases/AnyUseSuspenseQueryOptions.md) - [DataTag](type-aliases/DataTag.md) - [dataTagErrorSymbol](type-aliases/dataTagErrorSymbol.md) - [dataTagSymbol](type-aliases/dataTagSymbol.md) - [DefaultedInfiniteQueryObserverOptions](type-aliases/DefaultedInfiniteQueryObserverOptions.md) - [DefaultedQueryObserverOptions](type-aliases/DefaultedQueryObserverOptions.md) - [DefaultError](type-aliases/DefaultError.md) - [DefinedInfiniteQueryObserverResult](type-aliases/DefinedInfiniteQueryObserverResult.md) - [DefinedInitialDataInfiniteOptions](type-aliases/DefinedInitialDataInfiniteOptions.md) - [DefinedInitialDataOptions](type-aliases/DefinedInitialDataOptions.md) - [DefinedQueryObserverResult](type-aliases/DefinedQueryObserverResult.md) - [DefinedUseInfiniteQueryResult](type-aliases/DefinedUseInfiniteQueryResult.md) - [DefinedUseQueryResult](type-aliases/DefinedUseQueryResult.md) - [DistributiveOmit](type-aliases/DistributiveOmit.md) - [~~EnsureInfiniteQueryDataOptions~~](type-aliases/EnsureInfiniteQueryDataOptions.md) - [~~FetchInfiniteQueryOptions~~](type-aliases/FetchInfiniteQueryOptions.md) - [FetchStatus](type-aliases/FetchStatus.md) - [GetNextPageParamFunction](type-aliases/GetNextPageParamFunction.md) - [GetPreviousPageParamFunction](type-aliases/GetPreviousPageParamFunction.md) - [InferDataFromTag](type-aliases/InferDataFromTag.md) - [InferErrorFromTag](type-aliases/InferErrorFromTag.md) - [InfiniteQueryExecuteOptions](type-aliases/InfiniteQueryExecuteOptions.md) - [InfiniteQueryObserverResult](type-aliases/InfiniteQueryObserverResult.md) - [InitialDataFunction](type-aliases/InitialDataFunction.md) - [ManagedTimerId](type-aliases/ManagedTimerId.md) - [MutateFunction](type-aliases/MutateFunction.md) - [MutateFunctionRest](type-aliases/MutateFunctionRest.md) - [MutationCacheNotifyEvent](type-aliases/MutationCacheNotifyEvent.md) - [MutationFunction](type-aliases/MutationFunction.md) - [MutationFunctionContext](type-aliases/MutationFunctionContext.md) - [MutationKey](type-aliases/MutationKey.md) - [MutationMeta](type-aliases/MutationMeta.md) - [MutationObserverResult](type-aliases/MutationObserverResult.md) - [MutationScope](type-aliases/MutationScope.md) - [MutationStatus](type-aliases/MutationStatus.md) - [NetworkMode](type-aliases/NetworkMode.md) - [NonUndefinedGuard](type-aliases/NonUndefinedGuard.md) - [NotifyEventType](type-aliases/NotifyEventType.md) - [NotifyOnChangeProps](type-aliases/NotifyOnChangeProps.md) - [OmitKeyof](type-aliases/OmitKeyof.md) - [Override](type-aliases/Override.md) - [PlaceholderDataFunction](type-aliases/PlaceholderDataFunction.md) - [QueriesOptions](type-aliases/QueriesOptions.md) - [QueriesPlaceholderDataFunction](type-aliases/QueriesPlaceholderDataFunction.md) - [QueriesResults](type-aliases/QueriesResults.md) - [QueryBooleanOption](type-aliases/QueryBooleanOption.md) - [QueryCacheNotifyEvent](type-aliases/QueryCacheNotifyEvent.md) - [QueryClientProviderProps](type-aliases/QueryClientProviderProps.md) - [QueryErrorClearResetFunction](type-aliases/QueryErrorClearResetFunction.md) - [QueryErrorIsResetFunction](type-aliases/QueryErrorIsResetFunction.md) - [QueryErrorResetBoundaryFunction](type-aliases/QueryErrorResetBoundaryFunction.md) - [QueryErrorResetFunction](type-aliases/QueryErrorResetFunction.md) - [QueryFunction](type-aliases/QueryFunction.md) - [QueryFunctionContext](type-aliases/QueryFunctionContext.md) - [QueryKey](type-aliases/QueryKey.md) - [QueryKeyHashFunction](type-aliases/QueryKeyHashFunction.md) - [QueryKeyWithDataTag](type-aliases/QueryKeyWithDataTag.md) - [QueryMeta](type-aliases/QueryMeta.md) - [QueryObserverResult](type-aliases/QueryObserverResult.md) - [QueryPersister](type-aliases/QueryPersister.md) - [QueryStatus](type-aliases/QueryStatus.md) - [SkipToken](type-aliases/SkipToken.md) - [StaleTime](type-aliases/StaleTime.md) - [StaleTimeFunction](type-aliases/StaleTimeFunction.md) - [SuspenseQueriesOptions](type-aliases/SuspenseQueriesOptions.md) - [SuspenseQueriesResults](type-aliases/SuspenseQueriesResults.md) - [ThrowOnError](type-aliases/ThrowOnError.md) - [TimeoutCallback](type-aliases/TimeoutCallback.md) - [TimeoutProvider](type-aliases/TimeoutProvider.md) - [UndefinedInitialDataInfiniteOptions](type-aliases/UndefinedInitialDataInfiniteOptions.md) - [UndefinedInitialDataOptions](type-aliases/UndefinedInitialDataOptions.md) - [UnsetMarker](type-aliases/UnsetMarker.md) - [UnusedSkipTokenInfiniteOptions](type-aliases/UnusedSkipTokenInfiniteOptions.md) - [UnusedSkipTokenOptions](type-aliases/UnusedSkipTokenOptions.md) - [Updater](type-aliases/Updater.md) - [UseBaseMutationResult](type-aliases/UseBaseMutationResult.md) - [UseBaseQueryResult](type-aliases/UseBaseQueryResult.md) - [UseInfiniteQueryResult](type-aliases/UseInfiniteQueryResult.md) - [UseMutateAsyncFunction](type-aliases/UseMutateAsyncFunction.md) - [UseMutateFunction](type-aliases/UseMutateFunction.md) - [UseMutationResult](type-aliases/UseMutationResult.md) - [UsePrefetchInfiniteQueryOptions](type-aliases/UsePrefetchInfiniteQueryOptions.md) - [UsePrefetchQueryOptions](type-aliases/UsePrefetchQueryOptions.md) - [UseQueryResult](type-aliases/UseQueryResult.md) - [UseSuspenseInfiniteQueryResult](type-aliases/UseSuspenseInfiniteQueryResult.md) - [UseSuspenseQueryResult](type-aliases/UseSuspenseQueryResult.md) - [WithRequired](type-aliases/WithRequired.md) ## Variables - [dataTagErrorSymbol](variables/dataTagErrorSymbol.md) - [dataTagSymbol](variables/dataTagSymbol.md) - [defaultScheduler](variables/defaultScheduler.md) - [environmentManager](variables/environmentManager.md) - [focusManager](variables/focusManager.md) - [IsRestoringProvider](variables/IsRestoringProvider.md) - [~~isServer~~](variables/isServer.md) - [notifyManager](variables/notifyManager.md) - [onlineManager](variables/onlineManager.md) - [QueryClientContext](variables/QueryClientContext.md) - [skipToken](variables/skipToken.md) - [timeoutManager](variables/timeoutManager.md) - [unsetMarker](variables/unsetMarker.md) ## Functions - [defaultShouldDehydrateMutation](functions/defaultShouldDehydrateMutation.md) - [defaultShouldDehydrateQuery](functions/defaultShouldDehydrateQuery.md) - [dehydrate](functions/dehydrate.md) - [dehydrateQuery](functions/dehydrateQuery.md) - [experimental\_streamedQuery](functions/experimental_streamedQuery.md) - [hashKey](functions/hashKey.md) - [hydrate](functions/hydrate.md) - [HydrationBoundary](functions/HydrationBoundary.md) - [infiniteQueryOptions](functions/infiniteQueryOptions.md) - [~~isCancelledError~~](functions/isCancelledError.md) - [keepPreviousData](functions/keepPreviousData.md) - [matchMutation](functions/matchMutation.md) - [matchQuery](functions/matchQuery.md) - [mutationOptions](functions/mutationOptions.md) - [noop](functions/noop.md) - [partialMatchKey](functions/partialMatchKey.md) - [QueryClientProvider](functions/QueryClientProvider.md) - [QueryErrorResetBoundary](functions/QueryErrorResetBoundary.md) - [queryOptions](functions/queryOptions.md) - [replaceEqualDeep](functions/replaceEqualDeep.md) - [shouldThrowError](functions/shouldThrowError.md) - [useInfiniteQuery](functions/useInfiniteQuery.md) - [useIsFetching](functions/useIsFetching.md) - [useIsMutating](functions/useIsMutating.md) - [useIsRestoring](functions/useIsRestoring.md) - [useMutation](functions/useMutation.md) - [useMutationState](functions/useMutationState.md) - [usePrefetchInfiniteQuery](functions/usePrefetchInfiniteQuery.md) - [usePrefetchQuery](functions/usePrefetchQuery.md) - [useQueries](functions/useQueries.md) - [useQuery](functions/useQuery.md) - [useQueryClient](functions/useQueryClient.md) - [useQueryErrorResetBoundary](functions/useQueryErrorResetBoundary.md) - [useSuspenseInfiniteQuery](functions/useSuspenseInfiniteQuery.md) - [useSuspenseQueries](functions/useSuspenseQueries.md) - [useSuspenseQuery](functions/useSuspenseQuery.md)