katanakit-js / InfiniteQueryObserverSuccessResult
Interface: InfiniteQueryObserverSuccessResult<TData, TError>
Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2506
Extends
InfiniteQueryObserverBaseResult<TData,TError>
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
TError | DefaultError |
Properties
| Property | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
data | TData | The last successfully resolved data for the query. | InfiniteQueryObserverBaseResult.data | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2507 |
dataUpdatedAt | number | The timestamp for when the query most recently returned the status as "success". | - | InfiniteQueryObserverBaseResult.dataUpdatedAt | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2232 |
error | null | The error object for the query, if an error was thrown. - Defaults to null. | InfiniteQueryObserverBaseResult.error | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2508 |
errorUpdateCount | number | The sum of all errors. | - | InfiniteQueryObserverBaseResult.errorUpdateCount | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2256 |
errorUpdatedAt | number | The timestamp for when the query most recently returned the status as "error". | - | InfiniteQueryObserverBaseResult.errorUpdatedAt | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2241 |
failureCount | number | The failure count for the query. - Incremented every time the query fails. - Reset to 0 when the query succeeds. | - | InfiniteQueryObserverBaseResult.failureCount | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2247 |
failureReason | TError | null | The failure reason for the query retry. - Reset to null when the query succeeds. | - | InfiniteQueryObserverBaseResult.failureReason | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2252 |
fetchNextPage | (options?) => Promise<InfiniteQueryObserverResult<TData, TError>> | This function allows you to fetch the next "page" of results. | - | InfiniteQueryObserverBaseResult.fetchNextPage | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2423 |
fetchPreviousPage | (options?) => Promise<InfiniteQueryObserverResult<TData, TError>> | This function allows you to fetch the previous "page" of results. | - | InfiniteQueryObserverBaseResult.fetchPreviousPage | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2427 |
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. | - | InfiniteQueryObserverBaseResult.fetchStatus | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2344 |
hasNextPage | boolean | Will be true if there is a next page to be fetched (known via the getNextPageParam option). | - | InfiniteQueryObserverBaseResult.hasNextPage | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2431 |
hasPreviousPage | boolean | Will be true if there is a previous page to be fetched (known via the getPreviousPageParam option). | - | InfiniteQueryObserverBaseResult.hasPreviousPage | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2435 |
isEnabled | boolean | true if this observer is enabled, false otherwise. | - | InfiniteQueryObserverBaseResult.isEnabled | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2324 |
isError | false | A derived boolean from the status variable, provided for convenience. - true if the query attempt resulted in an error. | InfiniteQueryObserverBaseResult.isError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2509 |
isFetched | boolean | Will be true if the query has been fetched. | - | InfiniteQueryObserverBaseResult.isFetched | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2265 |
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. | - | InfiniteQueryObserverBaseResult.isFetchedAfterMount | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2270 |
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. | - | InfiniteQueryObserverBaseResult.isFetching | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2275 |
isFetchingNextPage | boolean | Will be true while fetching the next page with fetchNextPage. | - | InfiniteQueryObserverBaseResult.isFetchingNextPage | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2443 |
isFetchingPreviousPage | boolean | Will be true while fetching the previous page with fetchPreviousPage. | - | InfiniteQueryObserverBaseResult.isFetchingPreviousPage | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2451 |
isFetchNextPageError | false | Will be true if the query failed while fetching the next page. | InfiniteQueryObserverBaseResult.isFetchNextPageError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2514 |
isFetchPreviousPageError | false | Will be true if the query failed while fetching the previous page. | InfiniteQueryObserverBaseResult.isFetchPreviousPageError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2515 |
isLoading | false | Is true whenever the first fetch for a query is in-flight. - Is the same as isFetching && isPending. | InfiniteQueryObserverBaseResult.isLoading | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2511 |
isLoadingError | false | Will be true if the query failed while fetching for the first time. | InfiniteQueryObserverBaseResult.isLoadingError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2512 |
isPaused | boolean | A derived boolean from the fetchStatus variable, provided for convenience. - The query wanted to fetch, but has been paused. | - | InfiniteQueryObserverBaseResult.isPaused | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2298 |
isPending | false | Will be pending if there's no cached data and no query attempt was finished yet. | InfiniteQueryObserverBaseResult.isPending | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2510 |
isPlaceholderData | false | Will be true if the data shown is the placeholder data. | InfiniteQueryObserverBaseResult.isPlaceholderData | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2517 |
isRefetchError | false | Will be true if the query failed while refetching. | InfiniteQueryObserverBaseResult.isRefetchError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2513 |
isRefetching | boolean | Is true whenever a background refetch is in-flight, which does not include initial pending. - Is the same as isFetching && !isPending. | - | InfiniteQueryObserverBaseResult.isRefetching | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2311 |
isStale | boolean | Will be true if the data in the cache is invalidated or if the data is older than the given staleTime. | - | InfiniteQueryObserverBaseResult.isStale | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2315 |
isSuccess | true | 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 | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2516 |
refetch | (options?) => Promise<QueryObserverResult<TData, TError>> | A function to manually refetch the query. | - | InfiniteQueryObserverBaseResult.refetch | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2328 |
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 | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2518 |