Query Docs
API Reference
- Preact Reference
- Functions / HydrationBoundary
- Functions / QueryClientProvider
- Functions / QueryErrorResetBoundary
- 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 / useInfiniteQuery
- Functions / useIsFetching
- Functions / useIsMutating
- Functions / useIsRestoring
- Functions / useMutation
- Functions / useMutationState
- Functions / usePrefetchInfiniteQuery
- Functions / usePrefetchQuery
- Functions / useQueries
- Functions / useQuery
- Functions / useQueryClient
- Functions / useQueryErrorResetBoundary
- Functions / useSuspenseInfiniteQuery
- Functions / useSuspenseQueries
- Functions / useSuspenseQuery
- Classes / CancelledError
- Classes / InfiniteQueryObserver
- Classes / Mutation
- Classes / MutationCache
- Classes / MutationObserver
- Classes / QueriesObserver
- Classes / Query
- Classes / QueryCache
- Classes / QueryClient
- Classes / QueryObserver
- Interfaces / CancelOptions
- Interfaces / DefaultOptions
- Interfaces / DehydrateOptions
- Interfaces / DehydratedState
- Interfaces / EnsureQueryDataOptions
- Interfaces / FetchNextPageOptions
- Interfaces / FetchPreviousPageOptions
- Interfaces / FetchQueryOptions
- Interfaces / FocusManager
- Interfaces / HydrateOptions
- Interfaces / HydrationBoundaryProps
- 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 / QueryErrorResetBoundaryProps
- 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
- Interfaces / UseBaseQueryOptions
- Interfaces / UseInfiniteQueryOptions
- Interfaces / UseMutationOptions
- Interfaces / UseQueryOptions
- Interfaces / UseSuspenseInfiniteQueryOptions
- Interfaces / UseSuspenseQueryOptions
- Types / AnyDataTag
- Types / AnyUseBaseQueryOptions
- Types / AnyUseInfiniteQueryOptions
- Types / AnyUseMutationOptions
- Types / AnyUseQueryOptions
- Types / AnyUseSuspenseInfiniteQueryOptions
- Types / AnyUseSuspenseQueryOptions
- Types / DataTag
- Types / DefaultError
- Types / DefaultedInfiniteQueryObserverOptions
- Types / DefaultedQueryObserverOptions
- Types / DefinedInfiniteQueryObserverResult
- Types / DefinedInitialDataInfiniteOptions
- Types / DefinedInitialDataOptions
- Types / DefinedQueryObserverResult
- Types / DefinedUseInfiniteQueryResult
- Types / DefinedUseQueryResult
- Types / DistributiveOmit
- Types / EnsureInfiniteQueryDataOptions
- Types / FetchInfiniteQueryOptions
- Types / FetchStatus
- Types / GetNextPageParamFunction
- Types / GetPreviousPageParamFunction
- Types / InferDataFromTag
- Types / InferErrorFromTag
- Types / InfiniteQueryExecuteOptions
- Types / InfiniteQueryObserverResult
- Types / InitialDataFunction
- Types / ManagedTimerId
- Types / MutateFunction
- Types / MutateFunctionRest
- Types / MutationCacheNotifyEvent
- Types / MutationFunction
- Types / MutationFunctionContext
- Types / MutationKey
- Types / MutationMeta
- Types / MutationObserverResult
- Types / MutationScope
- Types / MutationStatus
- Types / NetworkMode
- Types / NonUndefinedGuard
- Types / NotifyEventType
- Types / NotifyOnChangeProps
- Types / OmitKeyof
- Types / Override
- Types / PlaceholderDataFunction
- Types / QueriesOptions
- Types / QueriesPlaceholderDataFunction
- Types / QueriesResults
- Types / QueryBooleanOption
- Types / QueryCacheNotifyEvent
- Types / QueryClientProviderProps
- Types / QueryErrorClearResetFunction
- Types / QueryErrorIsResetFunction
- Types / QueryErrorResetBoundaryFunction
- Types / QueryErrorResetFunction
- Types / QueryFunction
- Types / QueryFunctionContext
- Types / QueryKey
- Types / QueryKeyHashFunction
- Types / QueryKeyWithDataTag
- Types / QueryMeta
- Types / QueryObserverResult
- Types / QueryPersister
- Types / QueryStatus
- Types / SkipToken
- Types / StaleTime
- Types / StaleTimeFunction
- Types / SuspenseQueriesOptions
- Types / SuspenseQueriesResults
- Types / ThrowOnError
- Types / TimeoutCallback
- Types / TimeoutProvider
- Types / UndefinedInitialDataInfiniteOptions
- Types / UndefinedInitialDataOptions
- Types / UnsetMarker
- Types / UnusedSkipTokenInfiniteOptions
- Types / UnusedSkipTokenOptions
- Types / Updater
- Types / UseBaseMutationResult
- Types / UseBaseQueryResult
- Types / UseInfiniteQueryResult
- Types / UseMutateAsyncFunction
- Types / UseMutateFunction
- Types / UseMutationResult
- Types / UsePrefetchInfiniteQueryOptions
- Types / UsePrefetchQueryOptions
- Types / UseQueryResult
- Types / UseSuspenseInfiniteQueryResult
- Types / UseSuspenseQueryResult
- Types / WithRequired
- Types / dataTagErrorSymbol
- Types / dataTagSymbol
- Variables / IsRestoringProvider
- Variables / QueryClientContext
- 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/preact/reference/index.md
API Reference
@tanstack/preact-query
Classes#
- CancelledError
- InfiniteQueryObserver
- Mutation
- MutationCache
- MutationObserver
- QueriesObserver
- Query
- QueryCache
- QueryClient
- QueryObserver
Interfaces#
- CancelOptions
- DefaultOptions
- DehydratedState
- DehydrateOptions
EnsureQueryDataOptions- FetchNextPageOptions
- FetchPreviousPageOptions
FetchQueryOptions- FocusManager
- HydrateOptions
- HydrationBoundaryProps
- 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
- QueryErrorResetBoundaryProps
- QueryExecuteOptions
- QueryFilters
- QueryObserverBaseResult
- QueryObserverLoadingErrorResult
- QueryObserverLoadingResult
- QueryObserverOptions
- QueryObserverPendingResult
- QueryObserverPlaceholderResult
- QueryObserverRefetchErrorResult
- QueryObserverSuccessResult
- QueryOptions
- QueryState
- RefetchOptions
- RefetchQueryFilters
- Register
- ResetOptions
- ResultOptions
- SetDataOptions
- TimeoutManager
- UseBaseQueryOptions
- UseInfiniteQueryOptions
- UseMutationOptions
- UseQueryOptions
- UseSuspenseInfiniteQueryOptions
- UseSuspenseQueryOptions
Type Aliases#
- AnyDataTag
- AnyUseBaseQueryOptions
- AnyUseInfiniteQueryOptions
- AnyUseMutationOptions
- AnyUseQueryOptions
- AnyUseSuspenseInfiniteQueryOptions
- AnyUseSuspenseQueryOptions
- DataTag
- dataTagErrorSymbol
- dataTagSymbol
- DefaultedInfiniteQueryObserverOptions
- DefaultedQueryObserverOptions
- DefaultError
- DefinedInfiniteQueryObserverResult
- DefinedInitialDataInfiniteOptions
- DefinedInitialDataOptions
- DefinedQueryObserverResult
- DefinedUseInfiniteQueryResult
- DefinedUseQueryResult
- DistributiveOmit
EnsureInfiniteQueryDataOptionsFetchInfiniteQueryOptions- FetchStatus
- GetNextPageParamFunction
- GetPreviousPageParamFunction
- InferDataFromTag
- InferErrorFromTag
- InfiniteQueryExecuteOptions
- InfiniteQueryObserverResult
- InitialDataFunction
- ManagedTimerId
- MutateFunction
- MutateFunctionRest
- MutationCacheNotifyEvent
- MutationFunction
- MutationFunctionContext
- MutationKey
- MutationMeta
- MutationObserverResult
- MutationScope
- MutationStatus
- NetworkMode
- NonUndefinedGuard
- NotifyEventType
- NotifyOnChangeProps
- OmitKeyof
- Override
- PlaceholderDataFunction
- QueriesOptions
- QueriesPlaceholderDataFunction
- QueriesResults
- QueryBooleanOption
- QueryCacheNotifyEvent
- QueryClientProviderProps
- QueryErrorClearResetFunction
- QueryErrorIsResetFunction
- QueryErrorResetBoundaryFunction
- QueryErrorResetFunction
- QueryFunction
- QueryFunctionContext
- QueryKey
- QueryKeyHashFunction
- QueryKeyWithDataTag
- QueryMeta
- QueryObserverResult
- QueryPersister
- QueryStatus
- SkipToken
- StaleTime
- StaleTimeFunction
- SuspenseQueriesOptions
- SuspenseQueriesResults
- ThrowOnError
- TimeoutCallback
- TimeoutProvider
- UndefinedInitialDataInfiniteOptions
- UndefinedInitialDataOptions
- UnsetMarker
- UnusedSkipTokenInfiniteOptions
- UnusedSkipTokenOptions
- Updater
- UseBaseMutationResult
- UseBaseQueryResult
- UseInfiniteQueryResult
- UseMutateAsyncFunction
- UseMutateFunction
- UseMutationResult
- UsePrefetchInfiniteQueryOptions
- UsePrefetchQueryOptions
- UseQueryResult
- UseSuspenseInfiniteQueryResult
- UseSuspenseQueryResult
- WithRequired
Variables#
- dataTagErrorSymbol
- dataTagSymbol
- defaultScheduler
- environmentManager
- focusManager
- IsRestoringProvider
isServer- notifyManager
- onlineManager
- QueryClientContext
- skipToken
- timeoutManager
- unsetMarker
Functions#
- defaultShouldDehydrateMutation
- defaultShouldDehydrateQuery
- dehydrate
- dehydrateQuery
- experimental_streamedQuery
- hashKey
- hydrate
- HydrationBoundary
- infiniteQueryOptions
isCancelledError- keepPreviousData
- matchMutation
- matchQuery
- mutationOptions
- noop
- partialMatchKey
- QueryClientProvider
- QueryErrorResetBoundary
- queryOptions
- replaceEqualDeep
- shouldThrowError
- useInfiniteQuery
- useIsFetching
- useIsMutating
- useIsRestoring
- useMutation
- useMutationState
- usePrefetchInfiniteQuery
- usePrefetchQuery
- useQueries
- useQuery
- useQueryClient
- useQueryErrorResetBoundary
- useSuspenseInfiniteQuery
- useSuspenseQueries
- useSuspenseQuery