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

QueryObserverSuccessResult

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

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

处于 success 状态且数据来自缓存的查询结果。

继承自

类型参数

TData

TData = unknown

TError

TError = DefaultError

属性

属性 类型 描述 重写自
data TData 查询最近一次成功解析的数据。 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 false false,因为首次拉取尚未进行中。 QueryObserverBaseResult.isLoading
isLoadingError false false,因为查询首次拉取时未失败。 QueryObserverBaseResult.isLoadingError
isPaused boolean 基于 fetchStatus 变量派生的布尔值,仅为方便使用。- 查询本应拉取,但已被 paused。 -
isPending false false,因为查询已有数据或某次查询尝试已结束。 QueryObserverBaseResult.isPending
isPlaceholderData false false,因为当前显示的数据并非 placeholderData。 QueryObserverBaseResult.isPlaceholderData
isRefetchError false false,因为查询后台重新拉取时未失败。 QueryObserverBaseResult.isRefetchError
isRefetching boolean 后台重新拉取正在进行中时为 true,不包括 初始 pending。- 与 isFetching && !isPending 相同。 -
isStale boolean 若缓存中的数据已被使失效,或数据早于给定的 staleTime,则为 true。 -
isSuccess true true,因为查询处于 success 状态。 QueryObserverBaseResult.isSuccess
refetch (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> 手动重新拉取查询的函数。 -
status "success" 'success',因为查询已收到无错误的响应,且可随时显示其数据。 QueryObserverBaseResult.status

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

译自上游 59d11de