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

InfiniteQueryObserverPlaceholderResult

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

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

一种处于 success 状态的无限查询(infinite query)结果,在查询尚无数据时显示 placeholderData。

继承自

类型参数

TData

TData = unknown

TError

TError = DefaultError

属性

属性 类型 描述 重写自
data TData 查询尚无数据时显示的 placeholderData。 InfiniteQueryObserverBaseResult.data
dataUpdatedAt number 查询最近一次返回 status 状态为 "success" 的时间戳。 -
error null null,因为查询不处于 error 状态。 InfiniteQueryObserverBaseResult.error
errorUpdateCount number 所有错误的总和。 -
errorUpdatedAt number 查询最近一次返回 status 状态为 "error" 的时间戳。 -
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,包括初始拉取(initial fetch)以及后台重新拉取(background refetch);- paused:查询本应拉取,但已被 paused;- idle:查询未在拉取中;- 更多信息请参阅 Network Mode。 -
hasNextPage boolean 若存在下一页可拉取(通过 getNextPageParam 选项判定),则为 true。 -
hasPreviousPage boolean 若存在上一页可拉取(通过 getPreviousPageParam 选项判定),则为 true。 -
isEnabled boolean 若此观察者(observer)已启用,则为 true;否则为 false。 -
isError false false,因为查询不处于 error 状态。 InfiniteQueryObserverBaseResult.isError
isFetched boolean 若查询已完成拉取,则为 true。 -
isFetchedAfterMount boolean 若组件挂载后已完成拉取,则为 true;- 此属性可用于避免显示任何先前缓存的数据。 -
isFetching boolean 基于 fetchStatus 变量派生的布尔值,仅作便利性提供:- 当 queryFn 正在执行时为 true,包括初始拉取(initial fetch)以及后台重新拉取(background refetch)。 -
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 true true,因为当前显示的数据是 placeholderData。 InfiniteQueryObserverBaseResult.isPlaceholderData
isRefetchError false false,因为重新拉取(refetching)未失败。 InfiniteQueryObserverBaseResult.isRefetchError
isRefetching boolean 后台重新拉取(background refetch)进行中时为 true,_不包括_初始拉取(initial fetch);- 其值与 isFetching && !isPending 相同。 -
isStale boolean 若缓存中的数据已被使失效(invalidated)或其年龄超过给定的 staleTime,则为 true。 -
isSuccess true true,因为查询处于 success 状态。 InfiniteQueryObserverBaseResult.isSuccess
refetch (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> 用于手动重新拉取查询的函数。 -
status "success" 'success',因为查询已收到无错误的响应,且已准备好显示其数据。 InfiniteQueryObserverBaseResult.status

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

译自上游 59d11de