Open History to see the last commit
1/* istanbul ignore file */
2β
3import type { Context } from 'solid-js'
4import type {
5 DefinedQueryObserverResult,
6 InfiniteQueryObserverOptions,
7 InfiniteQueryObserverResult,
8 MutateFunction,
9 MutationObserverOptions,
10 MutationObserverResult,
11 QueryClient,
12 QueryFilters,
13 QueryKey,
14 QueryObserverOptions,
15 QueryObserverResult,
16 QueryOptions,
17} from '@tanstack/query-core'
18β
19export interface ContextOptions {
20 /**
21 * Use this to pass your Solid Query context. Otherwise, `defaultContext` will be used.
22 */
23 context?: Context<QueryClient | undefined>
24}
25β
26/* --- Create Query and Create Base Query Types --- */
27export type SolidQueryKey = () => readonly unknown[]
28β
29export interface CreateBaseQueryOptions<
30 TQueryFnData = unknown,
31 TError = unknown,
32 TData = TQueryFnData,
33 TQueryData = TQueryFnData,
34 TQueryKey extends QueryKey = QueryKey,
35> extends ContextOptions,
36 QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {}
37β
38export interface CreateQueryOptions<
39 TQueryFnData = unknown,
40 TError = unknown,
41 TData = TQueryFnData,
42 TQueryKey extends () => readonly unknown[] = SolidQueryKey,
43> extends Omit<
44 CreateBaseQueryOptions<
45 TQueryFnData,
46 TError,
47 TData,
48 TQueryFnData,
49 ReturnType<TQueryKey>
50 >,
51 'queryKey'
52 > {
53 queryKey?: TQueryKey
54}
55β
56export type CreateBaseQueryResult<
57 TData = unknown,
58 TError = unknown,
59> = QueryObserverResult<TData, TError>
60β
61export type CreateQueryResult<
62 TData = unknown,
63 TError = unknown,
64> = CreateBaseQueryResult<TData, TError>
65β
66export type DefinedCreateBaseQueryResult<
67 TData = unknown,
68 TError = unknown,
69> = DefinedQueryObserverResult<TData, TError>
70β
71export type DefinedCreateQueryResult<
72 TData = unknown,
73 TError = unknown,
74> = DefinedCreateBaseQueryResult<TData, TError>
75β
76export type ParseQueryArgs<
77 TOptions extends Omit<
78 QueryOptions<any, any, any, ReturnType<TQueryKey>>,
79 'queryKey'
80 > & {
81 queryKey?: TQueryKey
82 },
83 TQueryKey extends () => readonly unknown[] = SolidQueryKey,
84> = TOptions['queryKey'] extends () => infer R
85 ? Omit<TOptions, 'queryKey'> & { queryKey?: R }
86 : TOptions
87β
88/* --- Create Infinite Queries Types --- */
89export interface CreateInfiniteQueryOptions<
90 TQueryFnData = unknown,
91 TError = unknown,
92 TData = TQueryFnData,
93 TQueryData = TQueryFnData,
94 TQueryKey extends () => readonly unknown[] = SolidQueryKey,
95> extends ContextOptions,
96 Omit<
97 InfiniteQueryObserverOptions<
98 TQueryFnData,
99 TError,
100 TData,
101 TQueryData,
102 ReturnType<TQueryKey>
103 >,
104 'queryKey'
105 > {
106 queryKey?: TQueryKey
107}
108β
109export type CreateInfiniteQueryResult<
110 TData = unknown,
111 TError = unknown,
112> = InfiniteQueryObserverResult<TData, TError>
113β
114/* --- Create Mutation Types --- */
115export interface CreateMutationOptions<
116 TData = unknown,
117 TError = unknown,
118 TVariables = void,
119 TContext = unknown,
120> extends ContextOptions,
121 Omit<
122 MutationObserverOptions<TData, TError, TVariables, TContext>,
123 '_defaulted' | 'variables'
124 > {}
125β
126export type CreateMutateFunction<
127 TData = unknown,
128 TError = unknown,
129 TVariables = void,
130 TContext = unknown,
131> = (
132 ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
133) => void
134β
135export type CreateMutateAsyncFunction<
136 TData = unknown,
137 TError = unknown,
138 TVariables = void,
139 TContext = unknown,
140> = MutateFunction<TData, TError, TVariables, TContext>
141β
142export type CreateBaseMutationResult<
143 TData = unknown,
144 TError = unknown,
145 TVariables = unknown,
146 TContext = unknown,
147> = Override<
148 MutationObserverResult<TData, TError, TVariables, TContext>,
149 { mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
150> & {
151 mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
152}
153β
154export type CreateMutationResult<
155 TData = unknown,
156 TError = unknown,
157 TVariables = unknown,
158 TContext = unknown,
159> = CreateBaseMutationResult<TData, TError, TVariables, TContext>
160β
161type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }
162β
163/* --- Use Is Fetching Types --- */
164export interface SolidQueryFilters extends Omit<QueryFilters, 'queryKey'> {
165 queryKey?: SolidQueryKey
166}
167β
168export type ParseFilterArgs<T extends SolidQueryFilters> =
169 T['queryKey'] extends () => infer R ? T & { queryKey: R } : T