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

types.ts

181 lines4.4 KB

1/* istanbul ignore file */
2​
3import type * as React from 'react'
4import type {
5 DefinedInfiniteQueryObserverResult,
6 DefinedQueryObserverResult,
7 DistributiveOmit,
8 InfiniteQueryObserverOptions,
9 InfiniteQueryObserverResult,
10 MutateFunction,
11 MutationObserverOptions,
12 MutationObserverResult,
13 OmitKeyof,
14 QueryKey,
15 QueryObserverOptions,
16 QueryObserverResult,
17} from '@tanstack/query-core'
18import type { QueryClient } from '@tanstack/query-core'
19​
20export interface ContextOptions {
21 /**
22 * Use this to pass your React Query context. Otherwise, `defaultContext` will be used.
23 */
24 context?: React.Context<QueryClient | undefined>
26​
27export interface UseBaseQueryOptions<
28 TQueryFnData = unknown,
29 TError = unknown,
30 TData = TQueryFnData,
31 TQueryData = TQueryFnData,
32 TQueryKey extends QueryKey = QueryKey,
33> extends ContextOptions,
34 QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {}
35​
36export interface UseQueryOptions<
37 TQueryFnData = unknown,
38 TError = unknown,
39 TData = TQueryFnData,
40 TQueryKey extends QueryKey = QueryKey,
41> extends UseBaseQueryOptions<
42 TQueryFnData,
43 TError,
44 TData,
45 TQueryFnData,
46 TQueryKey
47 > {
48 /**
49 * If set to `true`, the query will suspend when `status === 'loading'`
50 * and throw errors when `status === 'error'`.
51 * Defaults to `false`.
52 * @deprecated This option will be removed in the next major version.
53 */
54 suspense?: boolean
56​
57export type UseSuspenseQueryOptions<
58 TQueryFnData = unknown,
59 TError = unknown,
60 TData = TQueryFnData,
61 TQueryKey extends QueryKey = QueryKey,
62> = OmitKeyof<
63 UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
64 | 'enabled'
65 | 'useErrorBoundary'
66 | 'suspense'
67 | 'placeholderData'
68 | 'networkMode'
69 | 'onSuccess'
70 | 'onError'
71 | 'onSettled'
72 | 'getPreviousPageParam'
73 | 'getNextPageParam'
75​
76export interface UseInfiniteQueryOptions<
77 TQueryFnData = unknown,
78 TError = unknown,
79 TData = TQueryFnData,
80 TQueryData = TQueryFnData,
81 TQueryKey extends QueryKey = QueryKey,
82> extends ContextOptions,
83 InfiniteQueryObserverOptions<
84 TQueryFnData,
85 TError,
86 TData,
87 TQueryData,
88 TQueryKey
89 > {}
90​
91export type UseBaseQueryResult<
92 TData = unknown,
93 TError = unknown,
94> = QueryObserverResult<TData, TError>
95​
96export type UseQueryResult<
97 TData = unknown,
98 TError = unknown,
99> = UseBaseQueryResult<TData, TError>
100​
101export type UseSuspenseQueryResult<
102 TData = unknown,
103 TError = unknown,
104> = DistributiveOmit<
105 DefinedQueryObserverResult<TData, TError>,
106 'isPlaceholderData'
108​
109export type DefinedUseBaseQueryResult<
110 TData = unknown,
111 TError = unknown,
112> = DefinedQueryObserverResult<TData, TError>
113​
114export type DefinedUseQueryResult<
115 TData = unknown,
116 TError = unknown,
117> = DefinedUseBaseQueryResult<TData, TError>
118​
119export type UseInfiniteQueryResult<
120 TData = unknown,
121 TError = unknown,
122> = InfiniteQueryObserverResult<TData, TError>
123​
124export type DefinedUseInfiniteQueryResult<
125 TData = unknown,
126 TError = unknown,
127> = DefinedInfiniteQueryObserverResult<TData, TError>
128​
129export type UseSuspenseInfiniteQueryResult<
130 TData = unknown,
131 TError = unknown,
132> = OmitKeyof<
133 DefinedInfiniteQueryObserverResult<TData, TError>,
134 'isPlaceholderData'
136​
137export interface UseMutationOptions<
138 TData = unknown,
139 TError = unknown,
140 TVariables = void,
141 TContext = unknown,
142> extends ContextOptions,
143 Omit<
144 MutationObserverOptions<TData, TError, TVariables, TContext>,
145 '_defaulted' | 'variables'
146 > {}
147​
148export type UseMutateFunction<
149 TData = unknown,
150 TError = unknown,
151 TVariables = void,
152 TContext = unknown,
153> = (
154 ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
155) => void
156​
157export type UseMutateAsyncFunction<
158 TData = unknown,
159 TError = unknown,
160 TVariables = void,
161 TContext = unknown,
162> = MutateFunction<TData, TError, TVariables, TContext>
163​
164export type UseBaseMutationResult<
165 TData = unknown,
166 TError = unknown,
167 TVariables = unknown,
168 TContext = unknown,
169> = Override<
170 MutationObserverResult<TData, TError, TVariables, TContext>,
171 { mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
172> & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }
173​
174export type UseMutationResult<
175 TData = unknown,
176 TError = unknown,
177 TVariables = unknown,
178 TContext = unknown,
179> = UseBaseMutationResult<TData, TError, TVariables, TContext>
180​
181type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }