Framework
Version

usePrefetchQuery

tsx
usePrefetchQuery(options)
usePrefetchQuery(options)

選項

你可以傳遞所有能傳給 queryClient.prefetchQuery 的參數給 usePrefetchQuery。請注意以下為必要參數:

  • queryKey: QueryKey

    • 必填
    • 在渲染期間預先擷取的查詢鍵值 (query key)
  • queryFn: (context: QueryFunctionContext) => Promise<TData>

    • 必填(但僅在未定義預設查詢函式時適用) 詳見預設查詢函式說明。

回傳值

usePrefetchQuery 不會回傳任何內容,其用途僅在渲染階段觸發預先擷取,適用於包覆 useSuspenseQuery 元件的 suspense 邊界 (suspense boundary) 之前。