359 lines
8.5 KiB
Markdown
359 lines
8.5 KiB
Markdown
---
|
|
id: QueryObserverBaseResult
|
|
title: QueryObserverBaseResult
|
|
---
|
|
|
|
Defined in: [packages/query-core/src/types.ts:764](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L764)
|
|
|
|
## Extended by
|
|
|
|
- [`QueryObserverPendingResult`](QueryObserverPendingResult.md)
|
|
- [`QueryObserverLoadingResult`](QueryObserverLoadingResult.md)
|
|
- [`QueryObserverLoadingErrorResult`](QueryObserverLoadingErrorResult.md)
|
|
- [`QueryObserverRefetchErrorResult`](QueryObserverRefetchErrorResult.md)
|
|
- [`QueryObserverSuccessResult`](QueryObserverSuccessResult.md)
|
|
- [`QueryObserverPlaceholderResult`](QueryObserverPlaceholderResult.md)
|
|
- [`InfiniteQueryObserverBaseResult`](InfiniteQueryObserverBaseResult.md)
|
|
|
|
## Type Parameters
|
|
|
|
### TData
|
|
|
|
`TData` = `unknown`
|
|
|
|
### TError
|
|
|
|
`TError` = [`DefaultError`](../type-aliases/DefaultError.md)
|
|
|
|
## Properties
|
|
|
|
### data
|
|
|
|
```ts
|
|
data: TData | undefined;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:771](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L771)
|
|
|
|
The last successfully resolved data for the query.
|
|
|
|
***
|
|
|
|
### dataUpdatedAt
|
|
|
|
```ts
|
|
dataUpdatedAt: number;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:775](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L775)
|
|
|
|
The timestamp for when the query most recently returned the `status` as `"success"`.
|
|
|
|
***
|
|
|
|
### error
|
|
|
|
```ts
|
|
error: TError | null;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780)
|
|
|
|
The error object for the query, if an error was thrown.
|
|
- Defaults to `null`.
|
|
|
|
***
|
|
|
|
### errorUpdateCount
|
|
|
|
```ts
|
|
errorUpdateCount: number;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:799](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L799)
|
|
|
|
The sum of all errors.
|
|
|
|
***
|
|
|
|
### errorUpdatedAt
|
|
|
|
```ts
|
|
errorUpdatedAt: number;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:784](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L784)
|
|
|
|
The timestamp for when the query most recently returned the `status` as `"error"`.
|
|
|
|
***
|
|
|
|
### failureCount
|
|
|
|
```ts
|
|
failureCount: number;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790)
|
|
|
|
The failure count for the query.
|
|
- Incremented every time the query fails.
|
|
- Reset to `0` when the query succeeds.
|
|
|
|
***
|
|
|
|
### failureReason
|
|
|
|
```ts
|
|
failureReason: TError | null;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:795](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L795)
|
|
|
|
The failure reason for the query retry.
|
|
- Reset to `null` when the query succeeds.
|
|
|
|
***
|
|
|
|
### fetchStatus
|
|
|
|
```ts
|
|
fetchStatus: FetchStatus;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:889](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L889)
|
|
|
|
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](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information.
|
|
|
|
***
|
|
|
|
### isEnabled
|
|
|
|
```ts
|
|
isEnabled: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:867](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L867)
|
|
|
|
`true` if this observer is enabled, `false` otherwise.
|
|
|
|
***
|
|
|
|
### isError
|
|
|
|
```ts
|
|
isError: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:804](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L804)
|
|
|
|
A derived boolean from the `status` variable, provided for convenience.
|
|
- `true` if the query attempt resulted in an error.
|
|
|
|
***
|
|
|
|
### isFetched
|
|
|
|
```ts
|
|
isFetched: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:808](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L808)
|
|
|
|
Will be `true` if the query has been fetched.
|
|
|
|
***
|
|
|
|
### isFetchedAfterMount
|
|
|
|
```ts
|
|
isFetchedAfterMount: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:813](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L813)
|
|
|
|
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
|
|
|
|
```ts
|
|
isFetching: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818)
|
|
|
|
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.
|
|
|
|
***
|
|
|
|
### ~~isInitialLoading~~
|
|
|
|
```ts
|
|
isInitialLoading: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:836](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L836)
|
|
|
|
#### Deprecated
|
|
|
|
`isInitialLoading` is being deprecated in favor of `isLoading`
|
|
and will be removed in the next major version.
|
|
|
|
***
|
|
|
|
### isLoading
|
|
|
|
```ts
|
|
isLoading: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:823](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L823)
|
|
|
|
Is `true` whenever the first fetch for a query is in-flight.
|
|
- Is the same as `isFetching && isPending`.
|
|
|
|
***
|
|
|
|
### isLoadingError
|
|
|
|
```ts
|
|
isLoadingError: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:831](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L831)
|
|
|
|
Will be `true` if the query failed while fetching for the first time.
|
|
|
|
***
|
|
|
|
### isPaused
|
|
|
|
```ts
|
|
isPaused: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:841](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L841)
|
|
|
|
A derived boolean from the `fetchStatus` variable, provided for convenience.
|
|
- The query wanted to fetch, but has been `paused`.
|
|
|
|
***
|
|
|
|
### isPending
|
|
|
|
```ts
|
|
isPending: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:827](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L827)
|
|
|
|
Will be `pending` if there's no cached data and no query attempt was finished yet.
|
|
|
|
***
|
|
|
|
### isPlaceholderData
|
|
|
|
```ts
|
|
isPlaceholderData: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:845](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L845)
|
|
|
|
Will be `true` if the data shown is the placeholder data.
|
|
|
|
***
|
|
|
|
### isRefetchError
|
|
|
|
```ts
|
|
isRefetchError: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:849](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L849)
|
|
|
|
Will be `true` if the query failed while refetching.
|
|
|
|
***
|
|
|
|
### isRefetching
|
|
|
|
```ts
|
|
isRefetching: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:854](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L854)
|
|
|
|
Is `true` whenever a background refetch is in-flight, which _does not_ include initial `pending`.
|
|
- Is the same as `isFetching && !isPending`.
|
|
|
|
***
|
|
|
|
### isStale
|
|
|
|
```ts
|
|
isStale: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:858](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L858)
|
|
|
|
Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
|
|
|
|
***
|
|
|
|
### isSuccess
|
|
|
|
```ts
|
|
isSuccess: boolean;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:863](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L863)
|
|
|
|
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.
|
|
|
|
***
|
|
|
|
### refetch()
|
|
|
|
```ts
|
|
refetch: (options?) => Promise<QueryObserverResult<TData, TError>>;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:871](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L871)
|
|
|
|
A function to manually refetch the query.
|
|
|
|
#### Parameters
|
|
|
|
##### options?
|
|
|
|
[`RefetchOptions`](RefetchOptions.md)
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\>
|
|
|
|
***
|
|
|
|
### status
|
|
|
|
```ts
|
|
status: QueryStatus;
|
|
```
|
|
|
|
Defined in: [packages/query-core/src/types.ts:881](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L881)
|
|
|
|
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.
|