TanStack
Query
API Reference

QueryObserverSuccessResult

Defined in: packages/query-core/src/types.ts:1282

A query result in the success state with data from the cache.

Extends

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

Properties

PropertyTypeDescriptionOverrides
dataTDataThe last successfully resolved data for the query.QueryObserverBaseResult.data
dataUpdatedAtnumberThe timestamp for when the query most recently returned the status as "success".-
errornullnull, since the query isn't in the error state.QueryObserverBaseResult.error
errorUpdateCountnumberThe sum of all errors.-
errorUpdatedAtnumberThe timestamp for when the query most recently returned the status as "error".-
failureCountnumberThe failure count for the query. - Incremented every time the query fails. - Reset to 0 when the query succeeds.-
failureReasonTError | nullThe failure reason for the query retry. - Reset to null when the query succeeds.-
fetchStatus"fetching" | "paused" | "idle"The fetch status of the query. - fetching: Is true whenever the queryFn is executing, which includes initial pending as well as background refetch. - paused: The query wanted to fetch, but has been paused. - idle: The query is not fetching. - See Network Mode for more information.-
isEnabledbooleantrue if this observer is enabled, false otherwise.-
isErrorfalsefalse, since the query isn't in the error state.QueryObserverBaseResult.isError
isFetchedbooleanWill be true if the query has been fetched.-
isFetchedAfterMountbooleanWill be true if the query has been fetched after the component mounted. - This property can be used to not show any previously cached data.-
isFetchingbooleanA derived boolean from the fetchStatus variable, provided for convenience. - true whenever the queryFn is executing, which includes initial pending as well as background refetch.-
isInitialLoadingbooleanDeprecated isInitialLoading is being deprecated in favor of isLoading and will be removed in the next major version.-
isLoadingfalsefalse, since the first fetch isn't in flight.QueryObserverBaseResult.isLoading
isLoadingErrorfalsefalse, since the query didn't fail while fetching for the first time.QueryObserverBaseResult.isLoadingError
isPausedbooleanA derived boolean from the fetchStatus variable, provided for convenience. - The query wanted to fetch, but has been paused.-
isPendingfalsefalse, since the query has data or a query attempt has finished.QueryObserverBaseResult.isPending
isPlaceholderDatafalsefalse, since the data shown isn't the placeholderData.QueryObserverBaseResult.isPlaceholderData
isRefetchErrorfalsefalse, since the query didn't fail while refetching.QueryObserverBaseResult.isRefetchError
isRefetchingbooleanIs true whenever a background refetch is in-flight, which does not include initial pending. - Is the same as isFetching && !isPending.-
isStalebooleanWill be true if the data in the cache is invalidated or if the data is older than the given staleTime.-
isSuccesstruetrue, since the query is in the success state.QueryObserverBaseResult.isSuccess
refetch(options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>A function to manually refetch the query.-
status"success"'success', since the query has received a response with no errors and is ready to display its data.QueryObserverBaseResult.status
Edit on GitHub
Interfaces / QueryObserverRefetchErrorResult
Interfaces / QueryOptions