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

types.ts

111 lines2.6 KB

1import {
2 InfiniteQueryObserverOptions,
3 InfiniteQueryObserverResult,
4 MutationObserverResult,
5 QueryObserverOptions,
6 QueryObserverResult,
7 QueryKey,
8 MutationObserverOptions,
9 MutateFunction,
10} from '../core/types'
11​
12export interface UseBaseQueryOptions<
13 TQueryFnData = unknown,
14 TError = unknown,
15 TData = TQueryFnData,
16 TQueryData = TQueryFnData,
17 TQueryKey extends QueryKey = QueryKey
18> extends QueryObserverOptions<
19 TQueryFnData,
20 TError,
21 TData,
22 TQueryData,
23 TQueryKey
24 > {}
25​
26export interface UseQueryOptions<
27 TQueryFnData = unknown,
28 TError = unknown,
29 TData = TQueryFnData,
30 TQueryKey extends QueryKey = QueryKey
31> extends UseBaseQueryOptions<
32 TQueryFnData,
33 TError,
34 TData,
35 TQueryFnData,
36 TQueryKey
37 > {}
38​
39export interface UseInfiniteQueryOptions<
40 TQueryFnData = unknown,
41 TError = unknown,
42 TData = TQueryFnData,
43 TQueryData = TQueryFnData,
44 TQueryKey extends QueryKey = QueryKey
45> extends InfiniteQueryObserverOptions<
46 TQueryFnData,
47 TError,
48 TData,
49 TQueryData,
50 TQueryKey
51 > {}
52​
53export type UseBaseQueryResult<
54 TData = unknown,
55 TError = unknown
56> = QueryObserverResult<TData, TError>
57​
58export type UseQueryResult<
59 TData = unknown,
60 TError = unknown
61> = UseBaseQueryResult<TData, TError>
62​
63export type UseInfiniteQueryResult<
64 TData = unknown,
65 TError = unknown
66> = InfiniteQueryObserverResult<TData, TError>
67​
68export interface UseMutationOptions<
69 TData = unknown,
70 TError = unknown,
71 TVariables = void,
72 TContext = unknown
73> extends Omit<
74 MutationObserverOptions<TData, TError, TVariables, TContext>,
75 '_defaulted' | 'variables'
76 > {}
77​
78export type UseMutateFunction<
79 TData = unknown,
80 TError = unknown,
81 TVariables = void,
82 TContext = unknown
83> = (
84 ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
85) => void
86​
87export type UseMutateAsyncFunction<
88 TData = unknown,
89 TError = unknown,
90 TVariables = void,
91 TContext = unknown
92> = MutateFunction<TData, TError, TVariables, TContext>
93​
94export type UseBaseMutationResult<
95 TData = unknown,
96 TError = unknown,
97 TVariables = unknown,
98 TContext = unknown
99> = Override<
100 MutationObserverResult<TData, TError, TVariables, TContext>,
101 { mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
102> & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }
103​
104export type UseMutationResult<
105 TData = unknown,
106 TError = unknown,
107 TVariables = unknown,
108 TContext = unknown
109> = UseBaseMutationResult<TData, TError, TVariables, TContext>
110​
111type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }