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

useQuery.ts

153 lines4.6 KB

1'use client'
2import { QueryObserver, parseQueryArgs } from '@tanstack/query-core'
3import { useBaseQuery } from './useBaseQuery'
4import type {
5 InitialDataFunction,
6 NonUndefinedGuard,
7 OmitKeyof,
8 QueryFunction,
9 QueryKey,
10} from '@tanstack/query-core'
11import type {
12 DefinedUseQueryResult,
13 UseQueryOptions,
14 UseQueryResult,
15} from './types'
16​
17// HOOK
18export function useQuery<
19 TQueryFnData = unknown,
20 TError = unknown,
21 TData = TQueryFnData,
22 TQueryKey extends QueryKey = QueryKey,
23>(
24 options: OmitKeyof<
25 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
26 'initialData'
27 > & {
28 initialData:
29 | NonUndefinedGuard<TQueryFnData>
30 | (() => NonUndefinedGuard<TQueryFnData>)
31 },
32): DefinedUseQueryResult<TData, TError>
33export function useQuery<
34 TQueryFnData = unknown,
35 TError = unknown,
36 TData = TQueryFnData,
37 TQueryKey extends QueryKey = QueryKey,
38>(
39 options: OmitKeyof<
40 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
41 'initialData'
42 > & {
43 initialData?:
44 | undefined
45 | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
46 | NonUndefinedGuard<TQueryFnData>
47 },
48): UseQueryResult<TData, TError>
49export function useQuery<
50 TQueryFnData = unknown,
51 TError = unknown,
52 TData = TQueryFnData,
53 TQueryKey extends QueryKey = QueryKey,
54>(
55 options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
56): UseQueryResult<TData, TError>
57​
58/** @deprecated This function overload will be removed in the next major version. */
59export function useQuery<
60 TQueryFnData = unknown,
61 TError = unknown,
62 TData = TQueryFnData,
63 TQueryKey extends QueryKey = QueryKey,
64>(
65 queryKey: TQueryKey,
66 options?: OmitKeyof<
67 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
68 'queryKey' | 'initialData'
69 >,
70): UseQueryResult<TData, TError>
71/** @deprecated This function overload will be removed in the next major version. */
72export function useQuery<
73 TQueryFnData = unknown,
74 TError = unknown,
75 TData = TQueryFnData,
76 TQueryKey extends QueryKey = QueryKey,
77>(
78 queryKey: TQueryKey,
79 options?: OmitKeyof<
80 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
81 'queryKey' | 'initialData'
82 > & { initialData: TQueryFnData | (() => TQueryFnData) },
83): DefinedUseQueryResult<TData, TError>
84/** @deprecated This function overload will be removed in the next major version. */
85export function useQuery<
86 TQueryFnData = unknown,
87 TError = unknown,
88 TData = TQueryFnData,
89 TQueryKey extends QueryKey = QueryKey,
90>(
91 queryKey: TQueryKey,
92 options?: OmitKeyof<
93 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
94 'queryKey'
95 >,
96): UseQueryResult<TData, TError>
97/** @deprecated This function overload will be removed in the next major version. */
98export function useQuery<
99 TQueryFnData = unknown,
100 TError = unknown,
101 TData = TQueryFnData,
102 TQueryKey extends QueryKey = QueryKey,
103>(
104 queryKey: TQueryKey,
105 queryFn: QueryFunction<TQueryFnData, TQueryKey>,
106 options?: OmitKeyof<
107 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
108 'queryKey' | 'queryFn' | 'initialData'
109 > & { initialData?: () => undefined },
110): UseQueryResult<TData, TError>
111/** @deprecated This function overload will be removed in the next major version. */
112export function useQuery<
113 TQueryFnData = unknown,
114 TError = unknown,
115 TData = TQueryFnData,
116 TQueryKey extends QueryKey = QueryKey,
117>(
118 queryKey: TQueryKey,
119 queryFn: QueryFunction<TQueryFnData, TQueryKey>,
120 options?: OmitKeyof<
121 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
122 'queryKey' | 'queryFn' | 'initialData'
123 > & { initialData: TQueryFnData | (() => TQueryFnData) },
124): DefinedUseQueryResult<TData, TError>
125/** @deprecated This function overload will be removed in the next major version. */
126export function useQuery<
127 TQueryFnData = unknown,
128 TError = unknown,
129 TData = TQueryFnData,
130 TQueryKey extends QueryKey = QueryKey,
131>(
132 queryKey: TQueryKey,
133 queryFn: QueryFunction<TQueryFnData, TQueryKey>,
134 options?: OmitKeyof<
135 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
136 'queryKey' | 'queryFn'
137 >,
138): UseQueryResult<TData, TError>
139export function useQuery<
140 TQueryFnData,
141 TError,
142 TData = TQueryFnData,
143 TQueryKey extends QueryKey = QueryKey,
144>(
145 arg1: TQueryKey | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
146 arg2?:
147 | QueryFunction<TQueryFnData, TQueryKey>
148 | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
149 arg3?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
150): UseQueryResult<TData, TError> {
151 const parsedOptions = parseQueryArgs(arg1, arg2, arg3)
152 return useBaseQuery(parsedOptions, QueryObserver)