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

InfiniteQueryObserverSuccessResult

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

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

处于 success 状态的无限查询结果,其数据来自缓存。

继承自

类型参数

TData

TData = unknown

TError

TError = DefaultError

属性

属性 类型 描述 重写自
data TData 查询最后一次成功解析的数据。 InfiniteQueryObserverBaseResult.data
dataUpdatedAt number 查询最近一次以 status 状态返回的时间戳。 -
error null null,因为查询当前不处于 error 状态。 InfiniteQueryObserverBaseResult.error
errorUpdateCount number 所有错误的总和。 -
errorUpdatedAt number 查询最近一次以 status 状态返回的时间戳。 -
failureCount number 查询失败次数。- 每次查询失败时递增。- 查询成功时重置为 0。 -
failureReason TError | null 查询重试失败的原因。- 查询成功时重置为 null。 -
fetchNextPage (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>> 此函数允许你拉取下一页结果。 -
fetchPreviousPage (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>> 此函数允许你拉取上一页结果。 -
fetchStatus "fetching" | "paused" | "idle" 查询的拉取状态。- fetching:当 queryFn 正在执行时为 true,包括初始 pending 和后台重新拉取。- paused:查询本应拉取,但已被 paused。- idle:查询未拉取。- 更多信息请参阅 Network Mode。 -
hasNextPage boolean 若存在下一页(通过 getNextPageParam 选项判定),则为 true。 -
hasPreviousPage boolean 若存在上一页(通过 getPreviousPageParam 选项判定),则为 true。 -
isEnabled boolean 若此观察者已启用,则为 true;否则为 false。 -
isError false false,因为查询当前不处于 error 状态。 InfiniteQueryObserverBaseResult.isError
isFetched boolean 若查询已完成拉取,则为 true。 -
isFetchedAfterMount boolean 若组件挂载后查询已完成拉取,则为 true。- 此属性可用于避免显示任何先前缓存的数据。 -
isFetching boolean 基于 fetchStatus 变量推导出的布尔值,便于使用。- 当 queryFn 正在执行时为 true,包括初始 pending 和后台重新拉取。 -
isFetchingNextPage boolean 使用 fetchNextPage 拉取下一页时为 true。 -
isFetchingPreviousPage boolean 使用 fetchPreviousPage 拉取上一页时为 true。 -
isFetchNextPageError false false,因为拉取下一页未失败。 InfiniteQueryObserverBaseResult.isFetchNextPageError
isFetchPreviousPageError false false,因为拉取上一页未失败。 InfiniteQueryObserverBaseResult.isFetchPreviousPageError
isInitialLoading boolean 已弃用 isInitialLoading 已被 isLoading 取代,将在下一个主版本中移除。 -
isLoading false false,因为首次拉取未进行中。 InfiniteQueryObserverBaseResult.isLoading
isLoadingError false false,因为首次拉取未失败。 InfiniteQueryObserverBaseResult.isLoadingError
isPaused boolean 基于 fetchStatus 变量推导出的布尔值,便于使用。- 查询本应拉取,但已被 paused。 -
isPending false false,因为查询已有数据或某次查询尝试已结束。 InfiniteQueryObserverBaseResult.isPending
isPlaceholderData false false,因为当前显示的数据并非 placeholderData。 InfiniteQueryObserverBaseResult.isPlaceholderData
isRefetchError false false,因为重新拉取未失败。 InfiniteQueryObserverBaseResult.isRefetchError
isRefetching boolean 后台重新拉取进行中时为 true,不包括 初始 pending。- 与 isFetching && !isPending 相同。 -
isStale boolean 若缓存中的数据已失效,或数据比给定的 staleTime 更旧,则为 true。 -
isSuccess true true,因为查询当前处于 success 状态。 InfiniteQueryObserverBaseResult.isSuccess
refetch (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> 用于手动重新拉取查询的函数。 -
status "success" 'success',因为查询已收到无错误响应,且可安全显示其数据。 InfiniteQueryObserverBaseResult.status

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

译自上游 59d11de