API Reference

QueryState

Defined in: packages/query-core/src/query.ts:52

The raw state stored on a Query instance. This is the underlying state that observer results (e.g. QueryObserverResult) are derived from.

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

Properties

PropertyTypeDescription
dataTData | undefinedThe last successfully resolved data for the query.
dataUpdateCountnumberThe number of times the query has successfully resolved.
dataUpdatedAtnumberThe timestamp for when the query most recently returned the status as "success".
errorTError | nullThe error object for the query, if the last attempt resulted in an error. - Defaults to null.
errorUpdateCountnumberThe sum of all errors, incremented every time the query resolves with an error.
errorUpdatedAtnumberThe timestamp for when the query most recently returned the status as "error".
fetchFailureCountnumberThe failure count for the current fetch. - Incremented every time the fetch fails. - Reset to 0 when the fetch succeeds.
fetchFailureReasonTError | nullThe reason the current fetch failed, as reported by the retryer. - Reset to null when the fetch succeeds.
fetchMetaFetchMeta | nullMetadata passed to the currently in-flight (or most recent) fetch, e.g. the fetchMore direction for infinite queries.
fetchStatus"fetching" | "paused" | "idle"The fetch status of the query. - fetching: the queryFn is currently executing. - paused: a fetch wanted to run but has been paused (see network mode). - idle: the query is not fetching.
isInvalidatedbooleanWhether the query has been marked as invalidated via invalidate(). - Reset to false whenever the query resolves successfully.
status"error" | "pending" | "success"The status of the query. - pending if there's no cached data and no attempt was finished yet. - error if the last attempt resulted in an error. - success if the query has data.