译零 TransZero · TanStack Query 中文文档
主站

QueryObserverLoadingResult

更新于 2026-11-02 Lit 查看英文原文 ↗

定义于:packages/query-core/src/types.ts:1138

当首次拉取正在进行中时,查询结果处于 pending 状态,因此 isLoading 为 true。

继承自

类型参数

TData

TData = unknown

TError

TError = DefaultError

属性

属性 类型 描述 覆盖自
data undefined undefined,因为查询尚无数据。 QueryObserverBaseResult.data
dataUpdatedAt number 查询最近一次返回 status 状态的时间戳,此时状态为 "success"。 -
error null null,因为查询不处于 error 状态。 QueryObserverBaseResult.error
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 false false,因为查询不处于 error 状态。 QueryObserverBaseResult.isError
isFetched boolean 若查询已被拉取,则为 true。 -
isFetchedAfterMount boolean 若组件挂载后查询已被拉取,则为 true。— 此属性可用于避免显示任何先前缓存的数据。 -
isFetching boolean 一个基于 fetchStatus 变量派生的布尔值,仅为方便使用。— 只要 queryFn 正在执行即为 true,包括初始 pending 和后台重新拉取。 -
isInitialLoading boolean 已弃用 isInitialLoading 已被 isLoading 取代,将在下一个主版本中移除。 -
isLoading true true,因为首次拉取正在进行中。 QueryObserverBaseResult.isLoading
isLoadingError false false,因为查询在首次拉取期间未失败。 QueryObserverBaseResult.isLoadingError
isPaused boolean 一个基于 fetchStatus 变量派生的布尔值,仅为方便使用。— 查询本应拉取,但已被 paused。 -
isPending true true,因为尚无缓存数据,且尚无查询尝试完成。 QueryObserverBaseResult.isPending
isPlaceholderData false false,因为所显示的数据并非 placeholderData。 QueryObserverBaseResult.isPlaceholderData
isRefetchError false false,因为查询在重新拉取期间未失败。 QueryObserverBaseResult.isRefetchError
isRefetching boolean 后台重新拉取正在进行中时为 true,这 不包括 初始 pending。— 其值与 isFetching && !isPending 相同。 -
isStale boolean 若缓存中的数据已被使失效,或数据比给定 staleTime 更旧,则为 true。 -
isSuccess false false,因为查询不处于 success 状态。 QueryObserverBaseResult.isSuccess
refetch (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> 用于手动重新拉取查询的函数。 -
status "pending" 'pending',因为尚无缓存数据,且尚无查询尝试完成。 QueryObserverBaseResult.status

本页为 TanStack Query 文档(Lit 版)的非官方中文翻译,原文由上游团队维护,遵循 MIT 许可。 译文如有偏差,以英文原文为准。

译自上游 59d11de