TanStack
Query
API Reference

InfiniteQueryObserverSuccessResult

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

Extends

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

Properties

PropertyTypeDescriptionOverrides
dataTDataThe last successfully resolved data for the query.InfiniteQueryObserverBaseResult.data
dataUpdatedAtnumberThe timestamp for when the query most recently returned the status as "success".-
errornullThe error object for the query, if an error was thrown. - Defaults to null.InfiniteQueryObserverBaseResult.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.-
fetchNextPage(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>This function allows you to fetch the next "page" of results.-
fetchPreviousPage(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>This function allows you to fetch the previous "page" of results.-
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.-
hasNextPagebooleanWill be true if there is a next page to be fetched (known via the getNextPageParam option).-
hasPreviousPagebooleanWill be true if there is a previous page to be fetched (known via the getPreviousPageParam option).-
isEnabledbooleantrue if this observer is enabled, false otherwise.-
isErrorfalseA derived boolean from the status variable, provided for convenience. - true if the query attempt resulted in an error.InfiniteQueryObserverBaseResult.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.-
isFetchingNextPagebooleanWill be true while fetching the next page with fetchNextPage.-
isFetchingPreviousPagebooleanWill be true while fetching the previous page with fetchPreviousPage.-
isFetchNextPageErrorfalseWill be true if the query failed while fetching the next page.InfiniteQueryObserverBaseResult.isFetchNextPageError
isFetchPreviousPageErrorfalseWill be true if the query failed while fetching the previous page.InfiniteQueryObserverBaseResult.isFetchPreviousPageError
isInitialLoadingbooleanDeprecated isInitialLoading is being deprecated in favor of isLoading and will be removed in the next major version.-
isLoadingfalseIs true whenever the first fetch for a query is in-flight. - Is the same as isFetching && isPending.InfiniteQueryObserverBaseResult.isLoading
isLoadingErrorfalseWill be true if the query failed while fetching for the first time.InfiniteQueryObserverBaseResult.isLoadingError
isPausedbooleanA derived boolean from the fetchStatus variable, provided for convenience. - The query wanted to fetch, but has been paused.-
isPendingfalseWill be pending if there's no cached data and no query attempt was finished yet.InfiniteQueryObserverBaseResult.isPending
isPlaceholderDatafalseWill be true if the data shown is the placeholder data.InfiniteQueryObserverBaseResult.isPlaceholderData
isRefetchErrorfalseWill be true if the query failed while refetching.InfiniteQueryObserverBaseResult.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.-
isSuccesstrueA derived boolean from the status variable, provided for convenience. - true if the query has received a response with no errors and is ready to display its data.InfiniteQueryObserverBaseResult.isSuccess
refetch(options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>A function to manually refetch the query.-
status"success"The status of the query. - Will be: - pending if there's no cached data and no query attempt was finished yet. - error if the query attempt resulted in an error. - success if the query has received a response with no errors and is ready to display its data.InfiniteQueryObserverBaseResult.status
Edit on GitHub
Interfaces / InfiniteQueryObserverRefetchErrorResult
Interfaces / InfiniteQueryPageParamsOptions