forked from TanStack/query
/
types.ts
99 lines (87 loc) 路 2.49 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
import type { Context } from 'solid-js'
import type {
QueryClient,
QueryKey,
QueryObserverOptions,
QueryObserverResult,
MutateFunction,
MutationObserverOptions,
MutationObserverResult,
} from '@tanstack/query-core'
export interface ContextOptions {
/**
* Use this to pass your React Query context. Otherwise, `defaultContext` will be used.
*/
context?: Context<QueryClient | undefined>
}
export type SolidQueryKey = () => readonly unknown[]
export interface CreateBaseQueryOptions<
TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> extends ContextOptions,
QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {}
export interface CreateQueryOptions<
TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
TQueryKey extends () => readonly unknown[] = SolidQueryKey,
> extends CreateBaseQueryOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
ReturnType<TQueryKey>
> {}
export type CreateBaseQueryResult<
TData = unknown,
TError = unknown,
> = QueryObserverResult<TData, TError>
export type CreateQueryResult<
TData = unknown,
TError = unknown,
> = CreateBaseQueryResult<TData, TError>
export interface CreateMutationOptions<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown,
> extends ContextOptions,
Omit<
MutationObserverOptions<TData, TError, TVariables, TContext>,
'_defaulted' | 'variables'
> {}
export type CreateMutateFunction<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown,
> = (
...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
) => void
export type CreateMutateAsyncFunction<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown,
> = MutateFunction<TData, TError, TVariables, TContext>
type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }
export type CreateBaseMutationResult<
TData = unknown,
TError = unknown,
TVariables = unknown,
TContext = unknown,
> = Override<
MutationObserverResult<TData, TError, TVariables, TContext>,
{ mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
> & {
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
}
export type CreateMutationResult<
TData = unknown,
TError = unknown,
TVariables = unknown,
TContext = unknown,
> = CreateBaseMutationResult<TData, TError, TVariables, TContext>