UseSuspenseQueryOptions
定义于：packages/react-query/src/types.ts:190
useSuspenseQuery 所接受的选项。与 UseQueryOptions 相同，但排除 enabled、throwOnError 和 placeholderData —— Suspense Hook 无法渲染「禁用」或「占位」状态，因此这些选项不适用。
继承自
OmitKeyof<UseQueryOptions<TQueryFnData,TError,TData,TQueryKey>,"queryFn"|"enabled"|"throwOnError"|"placeholderData">
类型参数
TQueryFnData
TQueryFnData = unknown
你的 queryFn 所解析出的类型。
TError
TError = DefaultError
你的 queryFn 可能抛出的错误类型。
TData
TData = TQueryFnData
data 经 select 处理后最终呈现的类型。若未使用 select，则默认为 TQueryFnData。
TQueryKey
TQueryKey extends QueryKey = QueryKey
你的 queryKey 的类型。
属性
| 属性 | 类型 | 默认值 | 描述 |
|---|---|---|---|
gcTime? |
number |
undefined |
未使用/非活跃缓存数据在内存中保留的毫秒数。当某个查询的缓存变为未使用或非活跃状态时，该缓存数据将在该持续时间后被垃圾回收。当指定了不同的垃圾回收时间时，将采用最长的那个。设为 Infinity 将禁用垃圾回收。默认为 5 * 60 * 1000（5 分钟），服务端渲染（SSR）期间则为 Infinity。注意：最大允许时间为约 24 天，这是由 setTimeout 的 32 位有符号整数延迟所限制 —— 详见 timeoutManager.setTimeoutProvider 中的变通方案。 |
initialData? |
TQueryFnData | (() => TQueryFnData | undefined) |
undefined |
若设置此值，则将其用作查询缓存的初始数据（前提是该查询尚未创建或缓存）。若设为函数，该函数将在共享/根查询初始化期间仅调用一次，且需同步返回初始数据。默认情况下，初始数据被视为过期，除非已设置 staleTime。initialData 会被持久化至缓存中。 |
initialDataUpdatedAt? |
number | (() => number | undefined) |
undefined |
若设置此值，则将其用作 initialData 本身最后更新时间（毫秒）。 |
maxPages? |
number |
undefined |
无限查询中数据所存储的最大页数。 |
meta? |
Record<string, unknown> |
undefined |
存储在每个查询上的额外负载。可利用此属性传递可在其他位置使用的附加信息。 |
networkMode? |
"online" | "always" | "offlineFirst" |
'online' |
控制查询是否允许基于当前网络连接状况运行。参见 Network Mode 获取更多信息。 |
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: object) => TQueryFnData | Promise<TQueryFnData>, context: object, query: Query) => TQueryFnData | Promise<TQueryFnData> |
undefined |
此选项可用于将查询结果持久化到外部存储，从而绕过实际调用 queryFn 的需要。适用于跨服务端/客户端边界持久化查询数据等场景。 |
queryFn? |
(context: object) => TQueryFnData | Promise<TQueryFnData> |
undefined |
skipToken 在此处不被允许 —— Suspense Hook 无法渲染「禁用」状态，因此必须始终提供查询函数，除非已定义默认查询函数。 |
queryHash? |
string |
undefined |
queryKey 的哈希形式，通过 queryKeyHashFn（或默认哈希函数）计算得出。内部用作实际缓存键。 |
queryKey |
TQueryKey & object |
undefined |
此查询所用的查询键。查询键将被哈希为稳定哈希值。详见 Query Keys 获取更多信息。只要 enabled 未设为 false，该键变更时查询将自动更新。 |
queryKeyHashFn? |
(queryKey: TQueryKey) => string |
undefined |
若指定，此函数将用于将 queryKey 哈希为字符串。 |
refetchInterval? |
| number | false | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => number | false | undefined) |
false |
若设为数字，查询将以该毫秒频率持续重新拉取。若设为函数，该函数将使用最新数据和查询来计算频率。 |
refetchIntervalInBackground? |
boolean |
false |
若设为 true，查询将在其所在标签页/窗口处于后台时继续重新拉取。 |
refetchOnMount? |
| boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always") |
true |
若设为 true，查询在挂载时若数据过期则重新拉取。若设为 false，将禁用同一查询的额外实例触发后台重新拉取。若设为 'always'，查询将在挂载时始终重新拉取（除非使用 staleTime: 'static'）。若设为函数，该函数将使用最新数据和查询来计算该值。 |
refetchOnReconnect? |
| boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always") |
undefined |
若设为 true，查询在网络重连时若数据过期则重新拉取。若设为 false，查询在网络重连时不会重新拉取。若设为 'always'，查询将在网络重连时始终重新拉取（除非使用 staleTime: 'static'）。若设为函数，该函数将使用最新数据和查询来计算该值。默认为 true，除非 networkMode 为 'always'。 |
refetchOnWindowFocus? |
| boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, 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, TQueryFnData, TQueryKey>) => boolean) |
true |
若设为 false，包含错误的查询在挂载时将不会重试。若设为函数，该函数将使用查询来计算该值。 |
select? |
(data: TQueryFnData) => TData |
undefined |
此选项可用于转换或选取查询函数返回数据的一部分。它影响返回的 data 值，但不影响存储于查询缓存中的内容。select 函数仅在 data 发生变更，或 select 函数自身引用发生变更时执行。为优化性能，请对函数进行记忆化处理，使其引用在多次调用中保持稳定。 |
staleTime? |
| number | "static" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => number | "static") |
0 |
数据被视为过期后的毫秒数。若设为 Infinity，数据将永不被视为过期。若设为 'static'，数据将永不被视为过期。若设为函数，该函数将使用查询来计算 staleTime。 |
structuralSharing? |
boolean | ((oldData: unknown, newData: unknown) => unknown) |
true |
设为 false 可禁用查询结果间的结构共享。设为函数时，该函数接收旧数据和新数据，并返回相同类型的已解析数据，以实现自定义结构共享逻辑。 |
subscribed? |
boolean |
true |
设为 false 可取消此观察者对查询缓存更新的订阅。 |