upstream/upstream-tanstack-query
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
upstream-tanstack-query/docs/framework/angular/reference/interfaces/InfiniteQueryObserverBaseResult.md
upstream-mirror 3a013ccdfe
Some checks failed
autofix.ci / autofix (push) Failing after 4s
Details
Release / Release (push) Has been skipped
Details
GitHub Actions Security Analysis / Run zizmor (push) Failing after 2s
Details
snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)
2026-09-16 01:13:08 +05:00

15 KiB
Raw Permalink Blame History

id, title
id title
InfiniteQueryObserverBaseResult InfiniteQueryObserverBaseResult

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

Extends

Extended by

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

Properties

data

data: TData | undefined;

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

The last successfully resolved data for the query.

Inherited from

QueryObserverBaseResult.data

dataUpdatedAt

dataUpdatedAt: number;

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

The timestamp for when the query most recently returned the status as "success".

Inherited from

QueryObserverBaseResult.dataUpdatedAt

error

error: TError | null;

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

The error object for the query, if an error was thrown.

  • Defaults to null.

Inherited from

QueryObserverBaseResult.error

errorUpdateCount

errorUpdateCount: number;

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

The sum of all errors.

Inherited from

QueryObserverBaseResult.errorUpdateCount

errorUpdatedAt

errorUpdatedAt: number;

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

The timestamp for when the query most recently returned the status as "error".

Inherited from

QueryObserverBaseResult.errorUpdatedAt

failureCount

failureCount: number;

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

The failure count for the query.

  • Incremented every time the query fails.
  • Reset to 0 when the query succeeds.

Inherited from

QueryObserverBaseResult.failureCount

failureReason

failureReason: TError | null;

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

The failure reason for the query retry.

  • Reset to null when the query succeeds.

Inherited from

QueryObserverBaseResult.failureReason

fetchNextPage()

fetchNextPage: (options?) => Promise<InfiniteQueryObserverResult<TData, TError>>;

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

This function allows you to fetch the next "page" of results.

Parameters

options?

FetchNextPageOptions

Returns

Promise<InfiniteQueryObserverResult<TData, TError>>

fetchPreviousPage()

fetchPreviousPage: (options?) => Promise<InfiniteQueryObserverResult<TData, TError>>;

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

This function allows you to fetch the previous "page" of results.

Parameters

options?

FetchPreviousPageOptions

Returns

Promise<InfiniteQueryObserverResult<TData, TError>>

fetchStatus

fetchStatus: FetchStatus;

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

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.

Inherited from

QueryObserverBaseResult.fetchStatus

hasNextPage

hasNextPage: boolean;

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

Will be true if there is a next page to be fetched (known via the getNextPageParam option).

hasPreviousPage

hasPreviousPage: boolean;

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

Will be true if there is a previous page to be fetched (known via the getPreviousPageParam option).

isEnabled

isEnabled: boolean;

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

true if this observer is enabled, false otherwise.

Inherited from

QueryObserverBaseResult.isEnabled

isError

isError: boolean;

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

A derived boolean from the status variable, provided for convenience.

  • true if the query attempt resulted in an error.

Inherited from

QueryObserverBaseResult.isError

isFetched

isFetched: boolean;

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

Will be true if the query has been fetched.

Inherited from

QueryObserverBaseResult.isFetched

isFetchedAfterMount

isFetchedAfterMount: boolean;

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

Will be true if the query has been fetched after the component mounted.

  • This property can be used to not show any previously cached data.

Inherited from

QueryObserverBaseResult.isFetchedAfterMount

isFetching

isFetching: boolean;

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

A derived boolean from the fetchStatus variable, provided for convenience.

  • true whenever the queryFn is executing, which includes initial pending as well as background refetch.

Inherited from

QueryObserverBaseResult.isFetching

isFetchingNextPage

isFetchingNextPage: boolean;

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

Will be true while fetching the next page with fetchNextPage.

isFetchingPreviousPage

isFetchingPreviousPage: boolean;

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

Will be true while fetching the previous page with fetchPreviousPage.

isFetchNextPageError

isFetchNextPageError: boolean;

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

Will be true if the query failed while fetching the next page.

isFetchPreviousPageError

isFetchPreviousPageError: boolean;

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

Will be true if the query failed while fetching the previous page.

isInitialLoading

isInitialLoading: boolean;

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

Deprecated

isInitialLoading is being deprecated in favor of isLoading and will be removed in the next major version.

Inherited from

QueryObserverBaseResult.isInitialLoading

isLoading

isLoading: boolean;

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

Is true whenever the first fetch for a query is in-flight.

  • Is the same as isFetching && isPending.

Inherited from

QueryObserverBaseResult.isLoading

isLoadingError

isLoadingError: boolean;

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

Will be true if the query failed while fetching for the first time.

Inherited from

QueryObserverBaseResult.isLoadingError

isPaused

isPaused: boolean;

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

A derived boolean from the fetchStatus variable, provided for convenience.

  • The query wanted to fetch, but has been paused.

Inherited from

QueryObserverBaseResult.isPaused

isPending

isPending: boolean;

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

Will be pending if there's no cached data and no query attempt was finished yet.

Inherited from

QueryObserverBaseResult.isPending

isPlaceholderData

isPlaceholderData: boolean;

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

Will be true if the data shown is the placeholder data.

Inherited from

QueryObserverBaseResult.isPlaceholderData

isRefetchError

isRefetchError: boolean;

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

Will be true if the query failed while refetching.

Inherited from

QueryObserverBaseResult.isRefetchError

isRefetching

isRefetching: boolean;

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

Is true whenever a background refetch is in-flight, which does not include initial pending.

  • Is the same as isFetching && !isPending.

Inherited from

QueryObserverBaseResult.isRefetching

isStale

isStale: boolean;

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

Will be true if the data in the cache is invalidated or if the data is older than the given staleTime.

Inherited from

QueryObserverBaseResult.isStale

isSuccess

isSuccess: boolean;

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

A 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.

Inherited from

QueryObserverBaseResult.isSuccess

refetch()

refetch: (options?) => Promise<QueryObserverResult<TData, TError>>;

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

A function to manually refetch the query.

Parameters

options?

RefetchOptions

Returns

Promise<QueryObserverResult<TData, TError>>

Inherited from

QueryObserverBaseResult.refetch

status

status: QueryStatus;

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

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.

Inherited from

QueryObserverBaseResult.status

Reference in New Issue View Git Blame Copy Permalink