Open History to see the last commit
1/* istanbul ignore file */
2β
3import type {
4 DefaultError,
5 DefinedInfiniteQueryObserverResult,
6 DefinedQueryObserverResult,
7 InfiniteQueryObserverResult,
8 MutateFunction,
9 MutationObserverOptions,
10 MutationObserverResult,
11 OmitKeyof,
12 Override,
13 QueryKey,
14 QueryObserverResult,
15} from '@tanstack/query-core'
16import type {
17 InfiniteQueryObserverOptions,
18 QueryObserverOptions,
19} from './QueryClient'
20β
21export type FunctionedParams<T> = () => T
22β
23export interface CreateBaseQueryOptions<
24 TQueryFnData = unknown,
25 TError = DefaultError,
26 TData = TQueryFnData,
27 TQueryData = TQueryFnData,
28 TQueryKey extends QueryKey = QueryKey,
29> extends OmitKeyof<
30 QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
31 'suspense'
32 > {
33 /**
34 * Only applicable while rendering queries on the server with streaming.
35 * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
36 * This can be useful to avoid sending a loading state to the client before the query has resolved.
37 * Defaults to `false`.
38 */
39 deferStream?: boolean
40 /**
41 * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
42 * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
43 * Setting `suspense` to `false` will be a no-op.
44 */
45 suspense?: boolean
46}
47β
48export interface SolidQueryOptions<
49 TQueryFnData = unknown,
50 TError = DefaultError,
51 TData = TQueryFnData,
52 TQueryKey extends QueryKey = QueryKey,
53> extends CreateBaseQueryOptions<
54 TQueryFnData,
55 TError,
56 TData,
57 TQueryFnData,
58 TQueryKey
59 > {}
60β
61export type CreateQueryOptions<
62 TQueryFnData = unknown,
63 TError = DefaultError,
64 TData = TQueryFnData,
65 TQueryKey extends QueryKey = QueryKey,
66> = FunctionedParams<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>
67β
68/* --- Create Query and Create Base Query Types --- */
69β
70export type CreateBaseQueryResult<
71 TData = unknown,
72 TError = DefaultError,
73> = QueryObserverResult<TData, TError>
74β
75export type CreateQueryResult<
76 TData = unknown,
77 TError = DefaultError,
78> = CreateBaseQueryResult<TData, TError>
79β
80export type DefinedCreateBaseQueryResult<
81 TData = unknown,
82 TError = DefaultError,
83> = DefinedQueryObserverResult<TData, TError>
84β
85export type DefinedCreateQueryResult<
86 TData = unknown,
87 TError = DefaultError,
88> = DefinedCreateBaseQueryResult<TData, TError>
89β
90/* --- Create Infinite Queries Types --- */
91export interface SolidInfiniteQueryOptions<
92 TQueryFnData = unknown,
93 TError = DefaultError,
94 TData = TQueryFnData,
95 TQueryData = TQueryFnData,
96 TQueryKey extends QueryKey = QueryKey,
97 TPageParam = unknown,
98> extends OmitKeyof<
99 InfiniteQueryObserverOptions<
100 TQueryFnData,
101 TError,
102 TData,
103 TQueryData,
104 TQueryKey,
105 TPageParam
106 >,
107 'queryKey' | 'suspense'
108 > {
109 queryKey: TQueryKey
110 /**
111 * Only applicable while rendering queries on the server with streaming.
112 * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
113 * This can be useful to avoid sending a loading state to the client before the query has resolved.
114 * Defaults to `false`.
115 */
116 deferStream?: boolean
117 /**
118 * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
119 * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
120 * Setting `suspense` to `false` will be a no-op.
121 */
122 suspense?: boolean
123}
124β
125export type CreateInfiniteQueryOptions<
126 TQueryFnData = unknown,
127 TError = DefaultError,
128 TData = TQueryFnData,
129 TQueryKey extends QueryKey = QueryKey,
130 TPageParam = unknown,
131> = FunctionedParams<
132 SolidInfiniteQueryOptions<
133 TQueryFnData,
134 TError,
135 TData,
136 TQueryFnData,
137 TQueryKey,
138 TPageParam
139 >
140>
141β
142export type CreateInfiniteQueryResult<
143 TData = unknown,
144 TError = DefaultError,
145> = InfiniteQueryObserverResult<TData, TError>
146β
147export type DefinedCreateInfiniteQueryResult<
148 TData = unknown,
149 TError = DefaultError,
150> = DefinedInfiniteQueryObserverResult<TData, TError>
151β
152/* --- Create Mutation Types --- */
153export interface SolidMutationOptions<
154 TData = unknown,
155 TError = DefaultError,
156 TVariables = void,
157 TContext = unknown,
158> extends OmitKeyof<
159 MutationObserverOptions<TData, TError, TVariables, TContext>,
160 '_defaulted'
161 > {}
162β
163export type CreateMutationOptions<
164 TData = unknown,
165 TError = DefaultError,
166 TVariables = void,
167 TContext = unknown,
168> = FunctionedParams<SolidMutationOptions<TData, TError, TVariables, TContext>>
169β
170export type CreateMutateFunction<
171 TData = unknown,
172 TError = DefaultError,
173 TVariables = void,
174 TContext = unknown,
175> = (
176 ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
177) => void
178β
179export type CreateMutateAsyncFunction<
180 TData = unknown,
181 TError = DefaultError,
182 TVariables = void,
183 TContext = unknown,
184> = MutateFunction<TData, TError, TVariables, TContext>
185β
186export type CreateBaseMutationResult<
187 TData = unknown,
188 TError = DefaultError,
189 TVariables = unknown,
190 TContext = unknown,
191> = Override<
192 MutationObserverResult<TData, TError, TVariables, TContext>,
193 { mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
194> & {
195 mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
196}
197β
198export type CreateMutationResult<
199 TData = unknown,
200 TError = DefaultError,
201 TVariables = unknown,
202 TContext = unknown,
203> = CreateBaseMutationResult<TData, TError, TVariables, TContext>