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

UseSuspenseInfiniteQueryOptions

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

定义于：packages/preact-query/src/types.ts:270

useSuspenseInfiniteQuery 所接受的选项。与 UseInfiniteQueryOptions 相同，但排除 enabled、throwOnError 和 placeholderData —— Suspense Hook 无法渲染“禁用”或“占位”状态，因此这些选项不适用。

继承自

类型参数

TQueryFnData

TQueryFnData = unknown

单页数据的类型，即你的 queryFn 所解析出的类型。

TError

TError = DefaultError

你的 queryFn 可能抛出的错误类型。

TData

TData = InfiniteData<TQueryFnData>

data 经 select 处理后最终得到的类型 — 默认为 InfiniteData<TQueryFnData>，即所有已拉取页面及其页面参数的结构。

TQueryKey

TQueryKey extends QueryKey = QueryKey

你的 queryKey 的类型。

TPageParam

TPageParam = unknown

传递给 queryFn 以拉取指定页面的参数类型。

属性 类型 默认值 描述
gcTime? number undefined 未使用/非活跃缓存数据在内存中保留的毫秒数。当某个查询的缓存变为未使用或非活跃状态后，该缓存数据将在该时长过后被垃圾回收。若指定了多个不同的垃圾回收时间，则取其中最长者生效。设为 Infinity 将禁用垃圾回收。默认值为 5 * 60 * 1000（5 分钟），服务端渲染（SSR）期间则为 Infinity。注意：受 setTimeout 的 32 位有符号整数延时限制，最大允许时间为约 24 天——参见 timeoutManager.setTimeoutProvider 获取变通方案。
getNextPageParam (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | null | undefined undefined 可设置该函数以自动获取无限查询的下一页游标。其返回值也将用于确定 hasNextPage 的值。
getPreviousPageParam? (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | null | undefined undefined 可设置该函数以自动获取无限查询的上一页游标。其返回值也将用于确定 hasPreviousPage 的值。
initialData? | InfiniteData<TQueryFnData, TPageParam> | (() => | InfiniteData<TQueryFnData, TPageParam> | undefined) undefined 若设置该值，它将作为查询缓存的初始数据（前提是该查询尚未创建或缓存）。若设为函数，则该函数将在共享/根查询初始化期间仅执行一次，且需同步返回初始数据。默认情况下，初始数据被视为过期，除非已设置 staleTime。initialData 会被持久化保存至缓存中。
initialDataUpdatedAt? number | (() => number | undefined) undefined 若设置该值，它将作为 initialData 本身最近一次更新的时间（毫秒）。
initialPageParam TPageParam undefined 当无限查询尚无任何页时，用于指定起始页码的参数。它将作为 queryFn 的 pageParam 参数传入第一页；后续每一页则使用 getNextPageParam 或 getPreviousPageParam 返回的值。该参数仅在查询尚未拥有任何页时生效：一旦存在第一页，重新拉取将从该页自身的参数开始。
maxPages? number undefined 无限查询的数据中最多可存储的页数。
meta? Record<string, unknown> undefined 存储于每个查询上的额外载荷。可利用此属性传递可在其他位置使用的附加信息。
networkMode? "online" | "always" | "offlineFirst" 'online' 控制查询是否允许基于当前网络连接状态运行。详见 网络模式。
notifyOnChangeProps? | ( | "error" | "data" | "isError" | "isPending" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "isPlaceholderData" | "status" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "failureReason" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isInitialLoading" | "isPaused" | "isRefetching" | "isStale" | "isEnabled" | "refetch" | "fetchStatus" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchNextPageError" | "isFetchingNextPage" | "isFetchPreviousPageError" | "isFetchingPreviousPage")[] | "all" | (() => | "all" | ( | "error" | "data" | "isError" | "isPending" | "isLoading" | "isLoadingError" | "isRefetchError" | "isSuccess" | "isPlaceholderData" | "status" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "failureReason" | "errorUpdateCount" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isInitialLoading" | "isPaused" | "isRefetching" | "isStale" | "isEnabled" | "refetch" | "fetchStatus" | "fetchNextPage" | "fetchPreviousPage" | "hasNextPage" | "hasPreviousPage" | "isFetchNextPageError" | "isFetchingNextPage" | "isFetchPreviousPageError" | "isFetchingPreviousPage")[] | undefined) undefined 若设置该值，组件仅在所列属性发生变更时重新渲染。设为 ['data', 'error'] 时，组件仅在 data 或 error 属性变更时重新渲染。设为 'all' 时，组件将在任意查询更新时重新渲染。设为函数时，该函数将被执行以计算需监听的属性列表。默认值为 undefined，此时会自动追踪属性访问，并仅在任一被追踪属性变更时触发重新渲染。
persister? (queryFn: (context: QueryFunctionContext<NoInfer<TQueryKey>, TPageParam>) => TQueryFnData | Promise<TQueryFnData>, context: object, query: Query) => TQueryFnData | Promise<TQueryFnData> undefined 此选项可用于将查询结果持久化到外部存储，从而绕过实际调用 queryFn 的需要。适用于跨服务端/客户端边界持久化查询数据等场景。
queryFn? (context: QueryFunctionContext<TQueryKey, TPageParam>) => TQueryFnData | Promise<TQueryFnData> undefined 此处不允许使用 skipToken —— Suspense Hook 无法渲染“禁用”状态，因此必须始终提供查询函数，除非已定义了默认查询函数。
queryHash? string undefined queryKey 的哈希形式，由 queryKeyHashFn（或默认哈希函数）计算得出。该哈希值将作为内部实际缓存键使用。
queryKey TQueryKey & object undefined 本查询所用的查询键。查询键将被哈希为一个稳定哈希值。更多信息请参阅 查询键。只要 enabled 未设为 false，该键一旦变更，查询便会自动更新。
queryKeyHashFn? (queryKey: TQueryKey) => string undefined 若指定该函数，则使用它对 queryKey 进行哈希并生成字符串。
refetchInterval? | number | false | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>) => number | false | undefined) false 若设为数字，查询将以该毫秒频率持续重新拉取。若设为函数，则该函数将接收最新数据和查询对象，用于计算重新拉取频率。
refetchIntervalInBackground? boolean false 若设为 true，查询将在其所在标签页/窗口处于后台时继续重新拉取。
refetchOnMount? | boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>) => boolean | "always") true 若设为 true，当数据过期时，查询将在挂载时重新拉取。若设为 false，将禁用同一查询的额外实例触发后台重新拉取。若设为 'always'，查询将在每次挂载时始终重新拉取（除非使用了 staleTime: 'static'）。若设为函数，则该函数将接收最新数据和查询对象，用于计算该值。
refetchOnReconnect? | boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>) => boolean | "always") undefined 若设为 true，当数据过期时，查询将在网络重连后重新拉取。若设为 false，查询在网络重连后不会重新拉取。若设为 'always'，查询将在每次网络重连后始终重新拉取（除非使用了 staleTime: 'static'）。若设为函数，则该函数将接收最新数据和查询对象，用于计算该值。默认值为 true，除非 networkMode 为 'always'。
refetchOnWindowFocus? | boolean | "always" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>) => boolean | "always") true 若设为 true，当数据过期时，查询将在窗口获得焦点时重新拉取。若设为 false，查询在窗口获得焦点时不会重新拉取。若设为 'always'，查询将在每次窗口获得焦点时始终重新拉取（除非使用了 staleTime: 'static'）。若设为函数，则该函数将接收最新数据和查询对象，用于计算该值。
retry? | number | false | true | ((failureCount: number, error: TError) => boolean) undefined 若为 false，失败查询默认不重试。若为 true，失败查询将无限重试。若设为整数（例如 3），失败查询将重试直至失败次数达到该数值。若设为函数 (failureCount, error) => boolean，失败查询将重试直至该函数返回 false。客户端默认为 3，服务端默认为 0。
retryDelay? number | ((failureCount: number, error: TError) => number) undefined 该函数接收一个 retryAttempt 整数和实际 Error，并返回下次尝试前应延迟的毫秒数。类似 attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000) 的函数实现指数退避；类似 attempt => attempt * 1000 的函数实现线性退避。默认函数实现指数退避，上限为 30 秒。
retryOnMount? | false | true | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>) => boolean) true 若设为 false，当查询包含错误时，其在挂载时不会重试。若设为函数，则该函数将接收查询对象以计算该值。
select? (data: InfiniteData) => TData undefined 此选项可用于转换或选取查询函数返回数据的一部分。它会影响返回的 data 值，但不影响存储于查询缓存中的内容。select 函数仅在 data 发生变更，或 select 函数自身引用发生变更时执行。为优化性能，请对函数进行记忆化处理，使其引用在多次调用中保持稳定。
staleTime? | number | "static" | ((query: Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>) => number | "static") 0 数据被视为过期前的毫秒数。若设为 Infinity，数据将永不被视为过期。若设为 'static'，数据将永不被视为过期。若设为函数，则该函数将接收查询对象以计算 staleTime。
structuralSharing? boolean | ((oldData: unknown, newData: unknown) => unknown) true 设为 false 可禁用查询结果之间的结构共享。设为函数时，该函数接收旧数据与新数据，并返回同类型解析后的数据，以实现自定义结构共享逻辑。
subscribed? boolean true 设为 false 可取消此观察者对查询缓存更新的订阅。

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

译自上游 59d11de