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

usePrefetchQuery.md

44 lines763 Bytes

1---
2id: usePrefetchQuery
3title: usePrefetchQuery
4---
5​
6# Function: usePrefetchQuery()
7​
8```ts
9function usePrefetchQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): void;
10```
11​
12Defined in: [preact-query/src/usePrefetchQuery.tsx:5](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/usePrefetchQuery.tsx#L5)
13​
14## Type Parameters
15​
16### TQueryFnData
17​
18`TQueryFnData` = `unknown`
19​
20### TError
21​
22`TError` = `Error`
23​
24### TData
25​
26`TData` = `TQueryFnData`
27​
28### TQueryKey
29​
30`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
31​
32## Parameters
33​
34### options
35​
36[`UsePrefetchQueryOptions`](../interfaces/UsePrefetchQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
37​
38### queryClient?
39​
40`QueryClient`
41​
42## Returns
43​
44`void`