QueryObserverBaseResult
定义于:packages/query-core/src/types.ts:961
每个查询结果状态所共有的属性,例如 data、error、status、is* 标志位以及 refetch。每个 QueryObserver*Result 都会针对一种特定状态对这些属性进行约束。
继承自
QueryObserverPendingResultQueryObserverLoadingResultQueryObserverLoadingErrorResultQueryObserverRefetchErrorResultQueryObserverSuccessResultQueryObserverPlaceholderResultInfiniteQueryObserverBaseResult
类型参数
TData
TData = unknown
TError
TError = DefaultError
属性
| 属性 | 类型 | 描述 |
|---|---|---|
data |
TData | undefined |
查询最后一次成功解析的数据。 |
dataUpdatedAt |
number |
查询最近一次以 status 状态返回 "success" 的时间戳。 |
error |
TError | null |
查询的错误对象(若抛出错误)。- 默认值为 null。 |
errorUpdateCount |
number |
所有错误的总数。 |
errorUpdatedAt |
number |
查询最近一次以 status 状态返回 "error" 的时间戳。 |
failureCount |
number |
查询失败次数。- 每次查询失败时递增。- 查询成功时重置为 0。 |
failureReason |
TError | null |
查询重试失败的原因。- 查询成功时重置为 null。 |
fetchStatus |
"fetching" | "paused" | "idle" |
查询的拉取状态。- fetching:当 queryFn 正在执行时为 true,包括初始 pending 和后台重新拉取。- paused:查询本应拉取,但已被 paused。- idle:查询未处于拉取中。- 更多信息请参阅 Network Mode。 |
isEnabled |
boolean |
若该观察者已启用则为 true,否则为 false。 |
isError |
boolean |
由 status 变量派生的布尔值,仅作便利之用。- 若查询尝试导致错误,则为 true。 |
isFetched |
boolean |
若查询已完成拉取,则为 true。 |
isFetchedAfterMount |
boolean |
若查询在组件挂载后完成拉取,则为 true。- 该属性可用于避免显示任何先前缓存的数据。 |
isFetching |
boolean |
由 fetchStatus 变量派生的布尔值,仅作便利之用。- 当 queryFn 正在执行时为 true,包括初始 pending 和后台重新拉取。 |
isInitialLoading |
boolean |
已弃用 isInitialLoading 已被 isLoading 取代,将在下一个主版本中移除。 |
isLoading |
boolean |
若查询的首次拉取正在进行中,则为 true。- 其语义等同于 isFetching && isPending。 |
isLoadingError |
boolean |
若查询在首次拉取期间失败,则为 true。 |
isPaused |
boolean |
由 fetchStatus 变量派生的布尔值,仅作便利之用。- 查询本应拉取,但已被 paused。 |
isPending |
boolean |
若尚无缓存数据且尚未完成任何查询尝试,则为 pending。 |
isPlaceholderData |
boolean |
若当前显示的数据为占位数据,则为 true。 |
isRefetchError |
boolean |
若查询在重新拉取期间失败,则为 true。 |
isRefetching |
boolean |
若后台重新拉取正在进行中,则为 true(不包含 初始 pending)。- 其语义等同于 isFetching && !isPending。 |
isStale |
boolean |
若缓存中的数据已被使失效,或数据早于给定的 staleTime,则为 true。 |
isSuccess |
boolean |
由 status 变量派生的布尔值,仅作便利之用。- 若查询已收到无错误的响应且可安全显示其数据,则为 true。 |
refetch |
(options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> |
用于手动重新拉取查询的函数。 |
status |
"error" | "pending" | "success" |
查询的状态。- 取值可能为:- pending:若尚无缓存数据且尚未完成任何查询尝试。- error:若查询尝试导致错误。- success:若查询已收到无错误的响应且可安全显示其数据。 |