0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md
Wonsuk Choi 0ca0523f31
docs({query-core,react,preact,vue,solid,svelte,angular}-query): describe the query result's 'status', its derived booleans and the error result types by the query's data and error (#12602)
* docs(query-core/types): describe 'status', 'isPending', 'isSuccess' and 'isError' of the query result by its current data and error

* docs(query-core/types): describe 'isLoadingError', 'isRefetchError' and the error result types by the current data and error, including 'select' failures

* docs(query-core/types): note that 'isRefetchError' is 'false' after a failed page fetch in infinite queries

* docs({query-core,react,preact,vue,solid,svelte,angular}-query): describe 'success' and 'pending' by cached data and 'placeholderData' since 'select' can return 'undefined'

* docs({query-core,react,preact,vue,solid,svelte,angular}-query): describe 'success' by cached data or data from 'placeholderData', and limit the 'select' returning 'undefined' case to cached data

* docs(docs/framework): revert generated reference pages to leave them to the post-merge workflow

* docs(docs/framework): regenerate reference pages with 'generate-docs'
2026-11-16 21:04:52 +09:00

8.1 KiB

id title
InfiniteQueryObserverPlaceholderResult InfiniteQueryObserverPlaceholderResult

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

An infinite query result in the success state that shows placeholderData while the query has no data yet.

Extends

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

Properties

Property Type Description Overrides
data TData The placeholderData shown while the query has no data yet. InfiniteQueryObserverBaseResult.data
dataUpdatedAt number The timestamp for when the query most recently returned the status as "success". -
error null null, since the query isn't in the error state. InfiniteQueryObserverBaseResult.error
errorUpdateCount number The sum of all errors. -
errorUpdatedAt number The timestamp for when the query most recently returned the status as "error". -
failureCount number The failure count for the query. - Incremented every time the query fails. - Reset to 0 when the query succeeds. -
failureReason TError | null The 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. -
hasNextPage boolean Will be true if there is a next page to be fetched (known via the getNextPageParam option). -
hasPreviousPage boolean Will be true if there is a previous page to be fetched (known via the getPreviousPageParam option). -
isEnabled boolean true if this observer is enabled, false otherwise. -
isError false false, since the query isn't in the error state. InfiniteQueryObserverBaseResult.isError
isFetched boolean Will be true if the query has been fetched. -
isFetchedAfterMount boolean 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. -
isFetching boolean 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. -
isFetchingNextPage boolean Will be true while fetching the next page with fetchNextPage. -
isFetchingPreviousPage boolean Will be true while fetching the previous page with fetchPreviousPage. -
isFetchNextPageError false false, since fetching the next page didn't fail. InfiniteQueryObserverBaseResult.isFetchNextPageError
isFetchPreviousPageError false false, since fetching the previous page didn't fail. InfiniteQueryObserverBaseResult.isFetchPreviousPageError
isInitialLoading boolean Deprecated isInitialLoading is being deprecated in favor of isLoading and will be removed in the next major version. -
isLoading false false, since the first fetch isn't in flight. InfiniteQueryObserverBaseResult.isLoading
isLoadingError false false, since the query didn't fail while fetching for the first time. InfiniteQueryObserverBaseResult.isLoadingError
isPaused boolean A derived boolean from the fetchStatus variable, provided for convenience. - The query wanted to fetch, but has been paused. -
isPending false false, since the query has cached data, data from placeholderData or an error. InfiniteQueryObserverBaseResult.isPending
isPlaceholderData true true, since the data shown is the placeholderData. InfiniteQueryObserverBaseResult.isPlaceholderData
isRefetchError false false, since the query didn't fail while refetching. InfiniteQueryObserverBaseResult.isRefetchError
isRefetching boolean Is true whenever a background refetch is in-flight, which does not include initial pending. - Is the same as isFetching && !isPending. -
isStale boolean Will be true if the data in the cache is invalidated or if the data is older than the given staleTime. -
isSuccess true true, since the query is in the success state. InfiniteQueryObserverBaseResult.isSuccess
refetch (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> A function to manually refetch the query. -
status "success" 'success', since the query shows placeholderData and has no error from a fetch or from select. InfiniteQueryObserverBaseResult.status