useSuspenseQuery
TypeScript
1function useSuspenseQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError>;定义于：packages/react-query/src/useSuspenseQuery.ts:73
useSuspenseQuery 的选项与 useQuery 相同，但排除 throwOnError、enabled 和 placeholderData；且 queryFn 不得为 skipToken，因为 Suspense Hook 无法渲染“禁用”状态。
注意：取消（cancellation）不生效。
类型参数
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
参数
options
UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>
要使用的 UseSuspenseQueryOptions —— 与 useQuery 的选项相同，但排除上述已列出的选项。
options 属性
| 属性 | 类型 | 默认值 | 描述 |
|---|---|---|---|
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 |
无限查询（infinite query）数据中最多存储的页数。 |
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 整数和实际错误，并返回下次尝试前应延迟的毫秒数。类似 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 可使此观察者取消订阅查询缓存的更新。 |
queryClient?
使用此参数可指定自定义 QueryClient。否则，将使用最近上下文中的 QueryClient。
返回值
UseSuspenseQueryResult<TData, TError>
与 useQuery 返回的对象相同，但 data 保证已定义，isPlaceholderData 缺失，且 status 为 success 或 error（相应派生标志已设置）。
返回值属性
基于 QueryObserverBaseResult 构建。参见上方类型定义了解其变更。
备注
同一组件内多次调用 useSuspenseQuery 将按顺序挂起，导致请求瀑布（request waterfall）—— 每次调用均会阻塞渲染直至其解析完成，因此下一次调用甚至尚未开始拉取。若组件中存在多个 Suspense 查询，请改用 useSuspenseQueries，以便它们并行拉取。
示例
若拉取失败且尚无缓存数据，查询错误将被抛出，因此 <Suspense> 周围必须包裹错误边界（error boundary）。而失败的后台重新拉取则会继续渲染缓存数据。可使用 QueryErrorResetBoundary 让用户在发生此类错误后重试：
TypeScript
1import { Suspense } from 'react'2import { ErrorBoundary } from 'react-error-boundary'3import { QueryErrorResetBoundary, useSuspenseQuery } from '@tanstack/react-query'4 5function Posts() {6 // `data` is guaranteed to be defined here — no `isPending` check needed.7 const { data, isFetching } = useSuspenseQuery({8 queryKey: ['posts'],9 queryFn: fetchPosts,10 })11 12 return (13 <div>14 <h1>Posts {isFetching ? '(refreshing...)' : null}</h1>15 <ul>16 {data.map((post) => (17 <li key={post.id}>{post.title}</li>18 ))}19 </ul>20 </div>21 )22}23 24function App() {25 return (26 <QueryErrorResetBoundary>27 {({ reset }) => (28 <ErrorBoundary29 onReset={reset}30 fallbackRender={({ resetErrorBoundary }) => (31 <div>32 There was an error!33 <button onClick={() => resetErrorBoundary()}>Try again</button>34 </div>35 )}36 >37 <Suspense fallback={<h1>Loading posts...</h1>}>38 <Posts />39 </Suspense>40 </ErrorBoundary>41 )}42 </QueryErrorResetBoundary>43 )44}