框架
版本

usePrefetchQuery

tsx
usePrefetchQuery(options)
usePrefetchQuery(options)

选项

你可以向 usePrefetchQuery 传递所有 queryClient.prefetchQuery 支持的参数。请注意以下必填项:

  • queryKey: QueryKey

    • 必填
    • 需要在渲染期间预取的查询键 (query key)
  • queryFn: (context: QueryFunctionContext) => Promise<TData>

    • 必填(但仅在未定义默认查询函数时适用) 更多信息请参阅 默认查询函数

返回值

usePrefetchQuery 不返回任何值,其用途仅是在渲染期间触发预取操作,通常用于包裹 useSuspenseQuery 组件的 suspense 边界之前执行。