useQuery

tsx

const {
  data,
  dataUpdatedAt,
  error,
  errorUpdatedAt,
  failureCount,
  failureReason,
  fetchStatus,
  isError,
  isFetched,
  isFetchedAfterMount,
  isFetching,
  isInitialLoading,
  isLoading,
  isLoadingError,
  isPaused,
  isPending,
  isPlaceholderData,
  isRefetchError,
  isRefetching,
  isStale,
  isSuccess,
  promise,
  refetch,
  status,
} = useQuery(
  {
    queryKey,
    queryFn,
    gcTime,
    enabled,
    networkMode,
    initialData,
    initialDataUpdatedAt,
    meta,
    notifyOnChangeProps,
    placeholderData,
    queryKeyHashFn,
    refetchInterval,
    refetchIntervalInBackground,
    refetchOnMount,
    refetchOnReconnect,
    refetchOnWindowFocus,
    retry,
    retryOnMount,
    retryDelay,
    select,
    staleTime,
    structuralSharing,
    subscribed,
    throwOnError,
  },
  queryClient,
)

const {
  data,
  dataUpdatedAt,
  error,
  errorUpdatedAt,
  failureCount,
  failureReason,
  fetchStatus,
  isError,
  isFetched,
  isFetchedAfterMount,
  isFetching,
  isInitialLoading,
  isLoading,
  isLoadingError,
  isPaused,
  isPending,
  isPlaceholderData,
  isRefetchError,
  isRefetching,
  isStale,
  isSuccess,
  promise,
  refetch,
  status,
} = useQuery(
  {
    queryKey,
    queryFn,
    gcTime,
    enabled,
    networkMode,
    initialData,
    initialDataUpdatedAt,
    meta,
    notifyOnChangeProps,
    placeholderData,
    queryKeyHashFn,
    refetchInterval,
    refetchIntervalInBackground,
    refetchOnMount,
    refetchOnReconnect,
    refetchOnWindowFocus,
    retry,
    retryOnMount,
    retryDelay,
    select,
    staleTime,
    structuralSharing,
    subscribed,
    throwOnError,
  },
  queryClient,
)

Parameter1 (选项)

queryKey: unknown[]
- 必需
- 用于此查询的查询键。
- 查询键将被哈希成一个稳定的哈希值。请参阅查询键以获取更多信息。
- 当此键更改时，查询将自动更新（只要 enabled 未设置为 false）。
queryFn: (context: QueryFunctionContext) => Promise<TData>
- 必需，但仅当未定义默认查询函数时 请参阅默认查询函数以获取更多信息。
- 查询将用于请求数据的函数。
- 接收 QueryFunctionContext
- 必须返回一个 promise，它将解析数据或抛出错误。数据不能是 undefined。
enabled: boolean | (query: Query) => boolean
- 设置为 false 以禁用此查询自动运行。
- 可用于依赖查询。
networkMode: 'online' | 'always' | 'offlineFirst
- 可选
- 默认为 'online'
- 请参阅网络模式以获取更多信息。
retry: boolean | number | (failureCount: number, error: TError) => boolean
- 如果为 false，则失败的查询默认不会重试。
- 如果为 true，则失败的查询将无限重试。
- 如果设置为数字，例如 3，则失败的查询将重试，直到失败的查询计数达到该数字。
- 客户端默认为 3，服务器端默认为 0
retryOnMount: boolean
- 如果设置为 false，如果查询包含错误，则在挂载时不会重试。默认为 true。
retryDelay: number | (retryAttempt: number, error: TError) => number
- 此函数接收一个 retryAttempt 整数和实际的 Error，并返回下一次尝试前应用的延迟（以毫秒为单位）。
- 类似 attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000) 的函数应用指数退避。
- 类似 attempt => attempt * 1000 的函数应用线性退避。
staleTime: number | ((query: Query) => number)
- 可选
- 默认为 0
- 数据被视为陈旧的毫秒数。此值仅适用于定义它的 hook。
- 如果设置为 Infinity，则数据将永远不会被视为陈旧
- 如果设置为函数，则将使用查询执行该函数以计算 staleTime。
gcTime: number | Infinity
- 默认为 5 * 60 * 1000 (5 分钟) 或 SSR 期间的 Infinity
- 未使用/非活动缓存数据在内存中保留的毫秒数。当查询的缓存变得未使用或非活动时，该缓存数据将在该持续时间后被垃圾回收。当指定不同的垃圾回收时间时，将使用最长的时间。
- 注意：允许的最大时间约为 24 天。请参阅更多。
- 如果设置为 Infinity，将禁用垃圾回收
queryKeyHashFn: (queryKey: QueryKey) => string
- 可选
- 如果指定，此函数用于将 queryKey 哈希为字符串。
refetchInterval: number | false | ((query: Query) => number | false | undefined)
- 可选
- 如果设置为数字，则所有查询将以该频率（以毫秒为单位）连续重新获取
- 如果设置为函数，则将使用查询执行该函数以计算频率
refetchIntervalInBackground: boolean
- 可选
- 如果设置为 true，则设置为使用 refetchInterval 连续重新获取的查询将在其选项卡/窗口在后台时继续重新获取
refetchOnMount: boolean | "always" | ((query: Query) => boolean | "always")
- 可选
- 默认为 true
- 如果设置为 true，如果数据陈旧，则查询将在挂载时重新获取。
- 如果设置为 false，则查询在挂载时不会重新获取。
- 如果设置为 "always"，则查询将始终在挂载时重新获取。
- 如果设置为函数，则将使用查询执行该函数以计算值
refetchOnWindowFocus: boolean | "always" | ((query: Query) => boolean | "always")
- 可选
- 默认为 true
- 如果设置为 true，如果数据陈旧，则查询将在窗口聚焦时重新获取。
- 如果设置为 false，则查询在窗口聚焦时不会重新获取。
- 如果设置为 "always"，则查询将始终在窗口聚焦时重新获取。
- 如果设置为函数，则将使用查询执行该函数以计算值
refetchOnReconnect: boolean | "always" | ((query: Query) => boolean | "always")
- 可选
- 默认为 true
- 如果设置为 true，如果数据陈旧，则查询将在重新连接时重新获取。
- 如果设置为 false，则查询在重新连接时不会重新获取。
- 如果设置为 "always"，则查询将始终在重新连接时重新获取。
- 如果设置为函数，则将使用查询执行该函数以计算值
notifyOnChangeProps: string[] | "all" | (() => string[] | "all" | undefined)
- 可选
- 如果设置，则仅当任何列出的属性更改时，组件才会重新渲染。
- 例如，如果设置为 ['data', 'error']，则仅当 data 或 error 属性更改时，组件才会重新渲染。
- 如果设置为 "all"，则组件将选择退出智能跟踪，并在每次查询更新时重新渲染。
- 如果设置为函数，将执行该函数以计算属性列表。
- 默认情况下，将跟踪对属性的访问，并且仅当跟踪的属性之一更改时，组件才会重新渲染。
select: (data: TData) => unknown
- 可选
- 此选项可用于转换或选择查询函数返回的数据的一部分。它会影响返回的 data 值，但不影响存储在查询缓存中的内容。
- 仅当 data 更改，或者对 select 函数本身的引用发生更改时，select 函数才会运行。为了优化，请将函数包装在 useCallback 中。
initialData: TData | () => TData
- 可选
- 如果设置，则此值将用作查询缓存的初始数据（只要尚未创建或缓存查询）
- 如果设置为函数，则将在共享/根查询初始化期间调用该函数一次，并期望同步返回 initialData
- 除非设置了 staleTime，否则默认情况下初始数据被视为陈旧。
- initialData 会被持久化到缓存中
initialDataUpdatedAt: number | (() => number | undefined)
- 可选
- 如果设置，则此值将用作 initialData 本身上次更新的时间（以毫秒为单位）。
placeholderData: TData | (previousValue: TData | undefined; previousQuery: Query | undefined,) => TData
- 可选
- 如果设置，则当查询仍处于 pending 状态时，此值将用作此特定查询观察者的占位符数据。
- placeholderData 不会持久化到缓存中
- 如果您为 placeholderData 提供一个函数，作为第一个参数，您将收到先前观察到的查询数据（如果可用），第二个参数将是完整的 previousQuery 实例。
structuralSharing: boolean | (oldData: unknown | undefined, newData: unknown) => unknown)
- 可选
- 默认为 true
- 如果设置为 false，则将禁用查询结果之间的结构共享。
- 如果设置为函数，则旧数据值和新数据值将通过此函数传递，该函数应将它们组合成查询的已解析数据。这样，即使旧数据包含不可序列化的值，您也可以保留对旧数据的引用以提高性能。
subscribed: boolean
- 可选
- 默认为 true
- 如果设置为 false，则此 useQuery 实例将不会订阅缓存。这意味着它不会自行触发 queryFn，并且如果数据通过其他方式进入缓存，它也不会接收更新。
throwOnError: undefined | boolean | (error: TError, query: Query) => boolean
- 如果您希望在渲染阶段抛出错误并传播到最近的错误边界，请将其设置为 true
- 设置为 false 以禁用 suspense 的将错误抛给错误边界的默认行为。
- 如果设置为函数，则会将错误和查询传递给它，并且它应返回一个布尔值，指示是否在错误边界中显示错误 (true) 或将错误作为状态返回 (false)
meta: Record<string, unknown>
- 可选
- 如果设置，则在查询缓存条目上存储可根据需要使用的附加信息。它将在 query 可用的任何地方访问，并且也是提供给 queryFn 的 QueryFunctionContext 的一部分。

Parameter2 (QueryClient)

queryClient?: QueryClient,
- 使用此项可使用自定义 QueryClient。否则，将使用来自最近上下文的 QueryClient。

status: QueryStatus
- 将会是
  - pending 如果没有缓存数据且尚未完成任何查询尝试。
  - error 如果查询尝试导致错误。相应的 error 属性具有从尝试的 fetch 收到的错误
  - success 如果查询已收到没有错误的响应并准备好显示其数据。查询上的相应 data 属性是来自成功 fetch 的数据，或者如果查询的 enabled 属性设置为 false 并且尚未获取 data 是初始化时提供给查询的第一个 initialData。
isPending: boolean
- 从上面的 status 变量派生的布尔值，为方便起见而提供。
isSuccess: boolean
- 从上面的 status 变量派生的布尔值，为方便起见而提供。
isError: boolean
- 从上面的 status 变量派生的布尔值，为方便起见而提供。
isLoadingError: boolean
- 如果查询在首次获取时失败，则为 true。
isRefetchError: boolean
- 如果查询在重新获取时失败，则为 true。
data: TData
- 默认为 undefined。
- 查询上次成功解析的数据。
dataUpdatedAt: number
- 查询最近一次将 status 返回为 "success" 的时间戳。
error: null | TError
- 默认为 null
- 查询的错误对象（如果抛出错误）。
errorUpdatedAt: number
- 查询最近一次将 status 返回为 "error" 的时间戳。
isStale: boolean
- 如果缓存中的数据已失效，或者数据早于给定的 staleTime，则为 true。
isPlaceholderData: boolean
- 如果显示的数据是占位符数据，则为 true。
isFetched: boolean
- 如果已获取查询，则为 true。
isFetchedAfterMount: boolean
- 如果在组件挂载后获取了查询，则为 true。
- 此属性可用于不显示任何先前缓存的数据。
fetchStatus: FetchStatus
- fetching：每当 queryFn 正在执行时为 true，其中包括初始 pending 以及后台重新获取。
- paused：查询想要获取，但已 paused。
- idle：查询未获取。
- 请参阅网络模式以获取更多信息。
isFetching: boolean
- 从上面的 fetchStatus 变量派生的布尔值，为方便起见而提供。
isPaused: boolean
- 从上面的 fetchStatus 变量派生的布尔值，为方便起见而提供。
isRefetching: boolean
- 每当后台重新获取正在进行中时为 true，不包括初始 pending
- 与 isFetching && !isPending 相同
isLoading: boolean
- 每当查询的首次获取正在进行中时为 true
- 与 isFetching && isPending 相同
isInitialLoading: boolean
- 已弃用
- 是 isLoading 的别名，将在下一个主要版本中删除。
failureCount: number
- 查询的失败计数。
- 每次查询失败时递增。
- 当查询成功时重置为 0。
failureReason: null | TError
- 查询重试的失败原因。
- 当查询成功时重置为 null。
errorUpdateCount: number
- 所有错误的总结。
refetch: (options: { throwOnError: boolean, cancelRefetch: boolean }) => Promise<UseQueryResult>
- 手动重新获取查询的函数。
- 如果查询出错，则只会记录错误。如果您希望抛出错误，请传递 throwOnError: true 选项
- cancelRefetch?: boolean
  - 默认为 true
    - 默认情况下，在发出新请求之前，将取消当前正在运行的请求
  - 当设置为 false 时，如果已有一个请求正在运行，则不会进行重新获取。
promise: Promise<TData>
- 将使用查询数据解析的稳定 promise。
- 需要 QueryClient 上启用的 experimental_prefetchInRender 功能标志。

想要跳过文档吗？

想要跳过文档吗？