katanakit-js / QueryObserverSuccessResult
Interface: QueryObserverSuccessResult<TData, TError>
Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2393
Extends
QueryObserverBaseResult<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. | QueryObserverBaseResult.data | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2394 |
dataUpdatedAt | number | The timestamp for when the query most recently returned the status as "success". | - | QueryObserverBaseResult.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. | QueryObserverBaseResult.error | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2395 |
errorUpdateCount | number | The sum of all errors. | - | QueryObserverBaseResult.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". | - | QueryObserverBaseResult.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. | - | QueryObserverBaseResult.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. | - | QueryObserverBaseResult.failureReason | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2252 |
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. | - | QueryObserverBaseResult.fetchStatus | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2344 |
isEnabled | boolean | true if this observer is enabled, false otherwise. | - | QueryObserverBaseResult.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. | QueryObserverBaseResult.isError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2396 |
isFetched | boolean | Will be true if the query has been fetched. | - | QueryObserverBaseResult.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. | - | QueryObserverBaseResult.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. | - | QueryObserverBaseResult.isFetching | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2275 |
isLoading | false | Is true whenever the first fetch for a query is in-flight. - Is the same as isFetching && isPending. | QueryObserverBaseResult.isLoading | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2398 |
isLoadingError | false | Will be true if the query failed while fetching for the first time. | QueryObserverBaseResult.isLoadingError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2399 |
isPaused | boolean | A derived boolean from the fetchStatus variable, provided for convenience. - The query wanted to fetch, but has been paused. | - | QueryObserverBaseResult.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. | QueryObserverBaseResult.isPending | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2397 |
isPlaceholderData | false | Will be true if the data shown is the placeholder data. | QueryObserverBaseResult.isPlaceholderData | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2402 |
isRefetchError | false | Will be true if the query failed while refetching. | QueryObserverBaseResult.isRefetchError | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2400 |
isRefetching | boolean | Is true whenever a background refetch is in-flight, which does not include initial pending. - Is the same as isFetching && !isPending. | - | QueryObserverBaseResult.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. | - | QueryObserverBaseResult.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. | QueryObserverBaseResult.isSuccess | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2401 |
refetch | (options?) => Promise<QueryObserverResult<TData, TError>> | A function to manually refetch the query. | - | QueryObserverBaseResult.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. | QueryObserverBaseResult.status | - | node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2403 |