mirror of
https://github.com/TanStack/query.git
synced 2026-11-18 19:33:22 +00:00
* docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases * docs(query-core/types): mention mutations in the 'hydrate' default options description
5.6 KiB
5.6 KiB
| id | title |
|---|---|
| QueryObserverPlaceholderResult | QueryObserverPlaceholderResult |
Defined in: packages/query-core/src/types.ts:1333
A query result in the success state that shows placeholderData while the query has no data
yet.
Extends
QueryObserverBaseResult<TData,TError>
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. |
QueryObserverBaseResult.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. |
QueryObserverBaseResult.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. |
- |
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. |
- |
isEnabled |
boolean |
true if this observer is enabled, false otherwise. |
- |
isError |
false |
false, since the query isn't in the error state. |
QueryObserverBaseResult.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. |
- |
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. |
QueryObserverBaseResult.isLoading |
isLoadingError |
false |
false, since the query didn't fail while fetching for the first time. |
QueryObserverBaseResult.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 data or a query attempt has finished. |
QueryObserverBaseResult.isPending |
isPlaceholderData |
true |
true, since the data shown is the placeholderData. |
QueryObserverBaseResult.isPlaceholderData |
isRefetchError |
false |
false, since the query didn't fail while refetching. |
QueryObserverBaseResult.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. |
QueryObserverBaseResult.isSuccess |
refetch |
(options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> |
A function to manually refetch the query. | - |
status |
"success" |
'success', since the query has received a response with no errors and is ready to display its data. |
QueryObserverBaseResult.status |