Skip to content

InfiniteQueryObserverLoadingResult.md

Latest commit

聽

History

History
58 lines (48 loc) 路 8 KB

InfiniteQueryObserverLoadingResult.md

File metadata and controls

58 lines (48 loc) 路 8 KB
Raw
id InfiniteQueryObserverLoadingResult
title InfiniteQueryObserverLoadingResult

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

Extends

Type Parameters

TData

TData = unknown

TError

TError = DefaultError

Properties

Property Type Description Overrides
data undefined The last successfully resolved data for the query. InfiniteQueryObserverBaseResult.data
dataUpdatedAt number The timestamp for when the query most recently returned the status as "success". -
error null The error object for the query, if an error was thrown. - Defaults to null. 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 A derived boolean from the status variable, provided for convenience. - true if the query attempt resulted in an error. 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 Will be true if the query failed while fetching the next page. InfiniteQueryObserverBaseResult.isFetchNextPageError
isFetchPreviousPageError false Will be true if the query failed while fetching the previous page. InfiniteQueryObserverBaseResult.isFetchPreviousPageError
isInitialLoading boolean Deprecated isInitialLoading is being deprecated in favor of isLoading and will be removed in the next major version. -
isLoading true Is true whenever the first fetch for a query is in-flight. - Is the same as isFetching && isPending. InfiniteQueryObserverBaseResult.isLoading
isLoadingError false Will be true if the query failed 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 true Will be pending if there's no cached data and no query attempt was finished yet. InfiniteQueryObserverBaseResult.isPending
isPlaceholderData false Will be true if the data shown is the placeholder data. InfiniteQueryObserverBaseResult.isPlaceholderData
isRefetchError false Will be true if the query failed 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 false 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. InfiniteQueryObserverBaseResult.isSuccess
refetch (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> A function to manually refetch the query. -
status "pending" 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