Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

usePrefetchQuery.md

24 lines847 Bytes

1---
2id: usePrefetchQuery
3title: usePrefetchQuery
4---
5​
6```tsx
7usePrefetchQuery(options)
8```
9​
10**Options**
11​
12You can pass everything to `usePrefetchQuery` that you can pass to [`queryClient.prefetchQuery`](../../../../reference/QueryClient#queryclientprefetchquery). Remember that some of them are required as below:
13​
14- `queryKey: QueryKey`
15​
16 - **Required**
17 - The query key to prefetch during render
18​
19- `queryFn: (context: QueryFunctionContext) => Promise<TData>`
20 - **Required, but only if no default query function has been defined** See [Default Query Function](../../guides/default-query-function) for more information.
21​
22**Returns**
23​
24The `usePrefetchQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses [`useSuspenseQuery`](../useSuspenseQuery).