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

useQuery.md

126 lines2.4 KB

1---
2id: useQuery
3title: useQuery
4---
5​
6# Function: useQuery()
7​
8## Call Signature
9​
10```ts
11function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): DefinedUseQueryResult<NoInfer<TData>, TError>;
12```
13​
14Defined in: [preact-query/src/useQuery.ts:19](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/useQuery.ts#L19)
15​
16### Type Parameters
17​
18#### TQueryFnData
19​
20`TQueryFnData` = `unknown`
21​
22#### TError
23​
24`TError` = `Error`
25​
26#### TData
27​
28`TData` = `TQueryFnData`
29​
30#### TQueryKey
31​
32`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
33​
34### Parameters
35​
36#### options
37​
38[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
39​
40#### queryClient?
41​
42`QueryClient`
43​
44### Returns
45​
46[`DefinedUseQueryResult`](../type-aliases/DefinedUseQueryResult.md)\<`NoInfer`\<`TData`\>, `TError`\>
47​
48## Call Signature
49​
50```ts
51function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): UseQueryResult<NoInfer<TData>, TError>;
52```
53​
54Defined in: [preact-query/src/useQuery.ts:29](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/useQuery.ts#L29)
55​
56### Type Parameters
57​
58#### TQueryFnData
59​
60`TQueryFnData` = `unknown`
61​
62#### TError
63​
64`TError` = `Error`
65​
66#### TData
67​
68`TData` = `TQueryFnData`
69​
70#### TQueryKey
71​
72`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
73​
74### Parameters
75​
76#### options
77​
78[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
79​
80#### queryClient?
81​
82`QueryClient`
83​
84### Returns
85​
86[`UseQueryResult`](../type-aliases/UseQueryResult.md)\<`NoInfer`\<`TData`\>, `TError`\>
87​
88## Call Signature
89​
90```ts
91function useQuery<TQueryFnData, TError, TData, TQueryKey>(options, queryClient?): UseQueryResult<NoInfer<TData>, TError>;
92```
93​
94Defined in: [preact-query/src/useQuery.ts:39](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/useQuery.ts#L39)
95​
96### Type Parameters
97​
98#### TQueryFnData
99​
100`TQueryFnData` = `unknown`
101​
102#### TError
103​
104`TError` = `Error`
105​
106#### TData
107​
108`TData` = `TQueryFnData`
109​
110#### TQueryKey
111​
112`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
113​
114### Parameters
115​
116#### options
117​
118[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
119​
120#### queryClient?
121​
122`QueryClient`
123​
124### Returns
125​
126[`UseQueryResult`](../type-aliases/UseQueryResult.md)\<`NoInfer`\<`TData`\>, `TError`\>