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

QueryObserverOptions

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

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

一个 QueryObserver 及其上构建的 Hook（例如 useQuery）所用的选项：包括该查询的 QueryOptions，以及控制观察者（observer）行为的选项，例如 enabled、staleTime、refetchInterval、select 和 placeholderData。

继承自

被以下类型扩展

类型参数

TQueryFnData

TQueryFnData = unknown

TError

TError = DefaultError

TData

TData = TQueryFnData

TQueryData

TQueryData = TQueryFnData

TQueryKey

TQueryKey extends QueryKey = QueryKey

TPageParam

TPageParam = never

属性

属性 类型 默认值 描述
enabled? | false | true | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean) true 将此项设为 false 或返回 false 的函数，可禁用查询挂载或查询键变更时的自动重新拉取。如需重新拉取查询，请使用 useQuery 实例返回的 refetch 方法。接受布尔值或返回布尔值的函数。
gcTime? number undefined 未使用/非活跃缓存数据在内存中保留的毫秒数。当某查询的缓存变为未使用或非活跃状态后，该缓存数据将在该持续时间后被垃圾回收。若指定了多个不同的垃圾回收时间，则采用最长的那个。设为 Infinity 将禁用垃圾回收。默认为 5 * 60 * 1000（5 分钟），服务端渲染（SSR）期间则为 Infinity。注意：受 setTimeout 的 32 位有符号整数延迟限制，最大允许时间为约 24 天——参见 timeoutManager.setTimeoutProvider 获取变通方案。
initialData? TQueryData | (() => TQueryData | 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: QueryFunctionContext<NoInfer<TQueryKey>, TPageParam>) => TQueryFnData | Promise<TQueryFnData>, context: object, query: Query) => TQueryFnData | Promise<TQueryFnData> undefined 此选项可用于将查询结果持久化到外部存储，从而绕过实际调用 queryFn 的需要。适用于跨服务端/客户端边界持久化查询数据等场景。
placeholderData? | NonFunctionGuard<TQueryData> | ((previousData: NonFunctionGuard<TQueryData> | undefined, previousQuery: | Query<NonFunctionGuard<TQueryData>, TError, NonFunctionGuard<TQueryData>, TQueryKey> | undefined) => NonFunctionGuard<TQueryData> | undefined) undefined 若设置此项，它将作为该特定查询观察者（query observer）在查询仍处于 loading 数据状态且未提供 initialData 时的占位数据。
queryFn? | typeof skipToken | ((context: QueryFunctionContext<TQueryKey, TPageParam>) => TQueryFnData | Promise<TQueryFnData>) undefined 查询用于请求数据的函数。必需，除非已通过 queryClient.setQueryDefaults 或 queryClient.setDefaultOptions 设置了默认查询函数。接收一个 QueryFunctionContext。必须返回一个 Promise，该 Promise 要么解析出数据，要么抛出错误。数据不能为 undefined。
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, TQueryData, TQueryKey>) => number | false | undefined) false 若设为数字，查询将以该毫秒频率持续重新拉取。若设为函数，该函数将使用最新数据和查询来计算频率。
refetchIntervalInBackground? boolean false 若设为 true，查询将在其所在标签页/窗口处于后台时继续重新拉取。
refetchOnMount? | boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always") true 若设为 true，当数据过期时，查询将在挂载时重新拉取。若设为 false，将禁用同一查询的额外实例触发后台重新拉取。若设为 'always'，查询将在挂载时始终重新拉取（除非使用 staleTime: 'static'）。若设为函数，该函数将使用最新数据和查询来计算该值。
refetchOnReconnect? | boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | "always") undefined 若设为 true，当数据过期时，查询将在重新连接网络时重新拉取。若设为 false，查询不会在网络重连时重新拉取。若设为 'always'，查询将在网络重连时始终重新拉取（除非使用 staleTime: 'static'）。若设为函数，该函数将使用最新数据和查询来计算该值。默认为 true，除非 networkMode 为 'always'。
refetchOnWindowFocus? | boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryData, 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, TQueryData, TQueryKey>) => boolean) true 若设为 false，当查询包含错误时，它在挂载时将不会重试。若设为函数，该函数将使用查询来计算该值。
select? (data: TQueryData) => TData undefined 此选项可用于转换或选取查询函数返回数据的一部分。它影响返回的 data 值，但不影响存储在查询缓存中的内容。select 函数仅在 data 发生变更或 select 函数自身引用发生变更时运行。为优化性能，请对函数进行记忆化处理，使其引用在多次调用中保持稳定。
staleTime? | number | "static" | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => number | "static") 0 数据被视为过期前的毫秒数。若设为 Infinity，数据将永远不会被视为过期。若设为 'static'，数据将永远不会被视为过期。若设为函数，该函数将使用查询来计算 staleTime。
structuralSharing? boolean | ((oldData: unknown, newData: unknown) => unknown) true 将此项设为 false 可禁用查询结果之间的结构共享。将此项设为一个接收旧数据和新数据并返回同类型解析后数据的函数，即可实现自定义结构共享逻辑。
suspense? boolean false 若设为 true，查询将在 status === 'pending' 时挂起，并在 status === 'error' 时抛出错误。
throwOnError? | false | true | ((error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean) false 是否应抛出错误而非设置 error 属性。若设为 true 或 suspense 为 true，所有错误都将抛出至错误边界。若设为 false 且 suspense 也为 false，错误将作为状态返回。若设为函数，该函数将接收错误和查询，并应返回一个布尔值，指示是否应在错误边界中显示该错误（true）或作为状态返回该错误（false）。

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

译自上游 59d11de