@navios/react-query 0.6.0 → 0.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/client/types.d.mts +337 -113
- package/dist/src/client/types.d.mts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/lib/_tsup-dts-rollup.d.mts +336 -112
- package/lib/_tsup-dts-rollup.d.ts +336 -112
- package/package.json +1 -1
- package/src/client/__type-tests__/client-instance.spec-d.mts +2 -2
- package/src/client/types.mts +617 -141
|
@@ -116,7 +116,7 @@ declare interface ClientInstance {
|
|
|
116
116
|
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
117
117
|
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
118
118
|
}): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
119
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
119
|
+
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
120
120
|
method: Method;
|
|
121
121
|
url: Url;
|
|
122
122
|
useKey: UseKey;
|
|
@@ -125,12 +125,20 @@ declare interface ClientInstance {
|
|
|
125
125
|
responseSchema: Response;
|
|
126
126
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
127
127
|
useContext?: () => Context;
|
|
128
|
-
|
|
129
|
-
|
|
128
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
129
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
130
|
+
onMutateResult: OnMutateResult | undefined;
|
|
131
|
+
}) => void | Promise<void>;
|
|
132
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
133
|
+
onMutateResult: OnMutateResult | undefined;
|
|
134
|
+
}) => void | Promise<void>;
|
|
135
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
136
|
+
onMutateResult: OnMutateResult | undefined;
|
|
137
|
+
}) => void | Promise<void>;
|
|
130
138
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
131
139
|
urlParams: UrlParams<Url>;
|
|
132
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema
|
|
133
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
|
|
140
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
141
|
+
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
134
142
|
method: Method;
|
|
135
143
|
url: Url;
|
|
136
144
|
requestSchema: RequestSchema;
|
|
@@ -138,20 +146,36 @@ declare interface ClientInstance {
|
|
|
138
146
|
responseSchema: Response;
|
|
139
147
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
140
148
|
useContext?: () => Context;
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
149
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
150
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
151
|
+
onMutateResult: OnMutateResult | undefined;
|
|
152
|
+
}) => void | Promise<void>;
|
|
153
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
154
|
+
onMutateResult: OnMutateResult | undefined;
|
|
155
|
+
}) => void | Promise<void>;
|
|
156
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
157
|
+
onMutateResult: OnMutateResult | undefined;
|
|
158
|
+
}) => void | Promise<void>;
|
|
159
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
160
|
+
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
145
161
|
method: Method;
|
|
146
162
|
url: Url;
|
|
147
163
|
requestSchema: RequestSchema;
|
|
148
164
|
responseSchema: Response;
|
|
149
165
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
150
166
|
useContext?: () => Context;
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
167
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
168
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
169
|
+
onMutateResult: OnMutateResult | undefined;
|
|
170
|
+
}) => void | Promise<void>;
|
|
171
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
172
|
+
onMutateResult: OnMutateResult | undefined;
|
|
173
|
+
}) => void | Promise<void>;
|
|
174
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
175
|
+
onMutateResult: OnMutateResult | undefined;
|
|
176
|
+
}) => void | Promise<void>;
|
|
177
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
178
|
+
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
155
179
|
method: Method;
|
|
156
180
|
url: Url;
|
|
157
181
|
useKey: UseKey;
|
|
@@ -159,12 +183,20 @@ declare interface ClientInstance {
|
|
|
159
183
|
responseSchema: Response;
|
|
160
184
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
161
185
|
useContext?: () => Context;
|
|
162
|
-
|
|
163
|
-
|
|
186
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
187
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
188
|
+
onMutateResult: OnMutateResult | undefined;
|
|
189
|
+
}) => void | Promise<void>;
|
|
190
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
191
|
+
onMutateResult: OnMutateResult | undefined;
|
|
192
|
+
}) => void | Promise<void>;
|
|
193
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
194
|
+
onMutateResult: OnMutateResult | undefined;
|
|
195
|
+
}) => void | Promise<void>;
|
|
164
196
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
165
197
|
urlParams: UrlParams<Url>;
|
|
166
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined
|
|
167
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
198
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
199
|
+
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
168
200
|
method: Method;
|
|
169
201
|
url: Url;
|
|
170
202
|
useKey: UseKey;
|
|
@@ -172,42 +204,74 @@ declare interface ClientInstance {
|
|
|
172
204
|
responseSchema: Response;
|
|
173
205
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
174
206
|
useContext?: () => Context;
|
|
175
|
-
|
|
176
|
-
|
|
207
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
208
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
209
|
+
onMutateResult: OnMutateResult | undefined;
|
|
210
|
+
}) => void | Promise<void>;
|
|
211
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
212
|
+
onMutateResult: OnMutateResult | undefined;
|
|
213
|
+
}) => void | Promise<void>;
|
|
214
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
215
|
+
onMutateResult: OnMutateResult | undefined;
|
|
216
|
+
}) => void | Promise<void>;
|
|
177
217
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
178
218
|
urlParams: UrlParams<Url>;
|
|
179
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema
|
|
180
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
|
|
219
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
220
|
+
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
181
221
|
method: Method;
|
|
182
222
|
url: Url;
|
|
183
223
|
querySchema: QuerySchema;
|
|
184
224
|
responseSchema: Response;
|
|
185
225
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
186
226
|
useContext?: () => Context;
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
227
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
228
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
229
|
+
onMutateResult: OnMutateResult | undefined;
|
|
230
|
+
}) => void | Promise<void>;
|
|
231
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
232
|
+
onMutateResult: OnMutateResult | undefined;
|
|
233
|
+
}) => void | Promise<void>;
|
|
234
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
235
|
+
onMutateResult: OnMutateResult | undefined;
|
|
236
|
+
}) => void | Promise<void>;
|
|
237
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
238
|
+
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
191
239
|
method: Method;
|
|
192
240
|
url: Url;
|
|
193
241
|
useKey: UseKey;
|
|
194
242
|
responseSchema: Response;
|
|
195
243
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
196
244
|
useContext?: () => Context;
|
|
197
|
-
|
|
198
|
-
|
|
245
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
246
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
247
|
+
onMutateResult: OnMutateResult | undefined;
|
|
248
|
+
}) => void | Promise<void>;
|
|
249
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
250
|
+
onMutateResult: OnMutateResult | undefined;
|
|
251
|
+
}) => void | Promise<void>;
|
|
252
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
253
|
+
onMutateResult: OnMutateResult | undefined;
|
|
254
|
+
}) => void | Promise<void>;
|
|
199
255
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
200
256
|
urlParams: UrlParams<Url>;
|
|
201
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined
|
|
202
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
|
|
257
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
|
|
258
|
+
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
203
259
|
method: Method;
|
|
204
260
|
url: Url;
|
|
205
261
|
responseSchema: Response;
|
|
206
262
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
207
263
|
useContext?: () => Context;
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
264
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
265
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
266
|
+
onMutateResult: OnMutateResult | undefined;
|
|
267
|
+
}) => void | Promise<void>;
|
|
268
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
269
|
+
onMutateResult: OnMutateResult | undefined;
|
|
270
|
+
}) => void | Promise<void>;
|
|
271
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
272
|
+
onMutateResult: OnMutateResult | undefined;
|
|
273
|
+
}) => void | Promise<void>;
|
|
274
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
|
|
211
275
|
queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: {
|
|
212
276
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
213
277
|
}, options?: {
|
|
@@ -225,81 +289,145 @@ declare interface ClientInstance {
|
|
|
225
289
|
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
226
290
|
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
227
291
|
}): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true>;
|
|
228
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
292
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
229
293
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
230
294
|
}, mutationOptions: {
|
|
231
295
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
232
296
|
useKey: UseKey;
|
|
233
297
|
useContext?: () => Context;
|
|
234
|
-
|
|
235
|
-
|
|
298
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
299
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
300
|
+
onMutateResult: OnMutateResult | undefined;
|
|
301
|
+
}) => void | Promise<void>;
|
|
302
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
303
|
+
onMutateResult: OnMutateResult | undefined;
|
|
304
|
+
}) => void | Promise<void>;
|
|
305
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
306
|
+
onMutateResult: OnMutateResult | undefined;
|
|
307
|
+
}) => void | Promise<void>;
|
|
236
308
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
237
309
|
urlParams: UrlParams<Url>;
|
|
238
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema
|
|
239
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
310
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
311
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
240
312
|
config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
|
|
241
313
|
}, mutationOptions: {
|
|
242
314
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
243
315
|
useKey: UseKey;
|
|
244
316
|
useContext?: () => Context;
|
|
245
|
-
|
|
246
|
-
|
|
317
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
318
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
319
|
+
onMutateResult: OnMutateResult | undefined;
|
|
320
|
+
}) => void | Promise<void>;
|
|
321
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
322
|
+
onMutateResult: OnMutateResult | undefined;
|
|
323
|
+
}) => void | Promise<void>;
|
|
324
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
325
|
+
onMutateResult: OnMutateResult | undefined;
|
|
326
|
+
}) => void | Promise<void>;
|
|
247
327
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
248
328
|
urlParams: UrlParams<Url>;
|
|
249
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined
|
|
250
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
|
|
329
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
|
|
330
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
251
331
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
252
332
|
}, mutationOptions: {
|
|
253
333
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
254
334
|
useContext?: () => Context;
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
335
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
336
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
337
|
+
onMutateResult: OnMutateResult | undefined;
|
|
338
|
+
}) => void | Promise<void>;
|
|
339
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
340
|
+
onMutateResult: OnMutateResult | undefined;
|
|
341
|
+
}) => void | Promise<void>;
|
|
342
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
343
|
+
onMutateResult: OnMutateResult | undefined;
|
|
344
|
+
}) => void | Promise<void>;
|
|
345
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
346
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
259
347
|
config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
|
|
260
348
|
}, mutationOptions: {
|
|
261
349
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
262
350
|
useContext?: () => Context;
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
351
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
352
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
353
|
+
onMutateResult: OnMutateResult | undefined;
|
|
354
|
+
}) => void | Promise<void>;
|
|
355
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
356
|
+
onMutateResult: OnMutateResult | undefined;
|
|
357
|
+
}) => void | Promise<void>;
|
|
358
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
359
|
+
onMutateResult: OnMutateResult | undefined;
|
|
360
|
+
}) => void | Promise<void>;
|
|
361
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
|
|
362
|
+
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
267
363
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
268
364
|
}, mutationOptions: {
|
|
269
365
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
270
366
|
useKey: UseKey;
|
|
271
367
|
useContext?: () => Context;
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
368
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
369
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
370
|
+
onMutateResult: OnMutateResult | undefined;
|
|
371
|
+
}) => void | Promise<void>;
|
|
372
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
373
|
+
onMutateResult: OnMutateResult | undefined;
|
|
374
|
+
}) => void | Promise<void>;
|
|
375
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
376
|
+
onMutateResult: OnMutateResult | undefined;
|
|
377
|
+
}) => void | Promise<void>;
|
|
378
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
379
|
+
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
276
380
|
config: BaseEndpointConfig<Method, Url, undefined, Response>;
|
|
277
381
|
}, mutationOptions: {
|
|
278
382
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
279
383
|
useKey: UseKey;
|
|
280
384
|
useContext?: () => Context;
|
|
281
|
-
|
|
282
|
-
|
|
385
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
386
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
387
|
+
onMutateResult: OnMutateResult | undefined;
|
|
388
|
+
}) => void | Promise<void>;
|
|
389
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
390
|
+
onMutateResult: OnMutateResult | undefined;
|
|
391
|
+
}) => void | Promise<void>;
|
|
392
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
393
|
+
onMutateResult: OnMutateResult | undefined;
|
|
394
|
+
}) => void | Promise<void>;
|
|
283
395
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
284
396
|
urlParams: UrlParams<Url>;
|
|
285
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined
|
|
286
|
-
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
|
|
397
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
|
|
398
|
+
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
287
399
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
288
400
|
}, mutationOptions: {
|
|
289
401
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
290
402
|
useContext?: () => Context;
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
403
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
404
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
405
|
+
onMutateResult: OnMutateResult | undefined;
|
|
406
|
+
}) => void | Promise<void>;
|
|
407
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
408
|
+
onMutateResult: OnMutateResult | undefined;
|
|
409
|
+
}) => void | Promise<void>;
|
|
410
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
411
|
+
onMutateResult: OnMutateResult | undefined;
|
|
412
|
+
}) => void | Promise<void>;
|
|
413
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
414
|
+
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
295
415
|
config: BaseEndpointConfig<Method, Url, undefined, Response>;
|
|
296
416
|
}, mutationOptions: {
|
|
297
417
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
298
418
|
useContext?: () => Context;
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
419
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
420
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
421
|
+
onMutateResult: OnMutateResult | undefined;
|
|
422
|
+
}) => void | Promise<void>;
|
|
423
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
424
|
+
onMutateResult: OnMutateResult | undefined;
|
|
425
|
+
}) => void | Promise<void>;
|
|
426
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
427
|
+
onMutateResult: OnMutateResult | undefined;
|
|
428
|
+
}) => void | Promise<void>;
|
|
429
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
|
|
430
|
+
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
303
431
|
method: Method;
|
|
304
432
|
url: Url;
|
|
305
433
|
useKey: UseKey;
|
|
@@ -308,12 +436,20 @@ declare interface ClientInstance {
|
|
|
308
436
|
responseSchema: Response;
|
|
309
437
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
310
438
|
useContext?: () => Context;
|
|
311
|
-
|
|
312
|
-
|
|
439
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
440
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
441
|
+
onMutateResult: OnMutateResult | undefined;
|
|
442
|
+
}) => void | Promise<void>;
|
|
443
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
444
|
+
onMutateResult: OnMutateResult | undefined;
|
|
445
|
+
}) => void | Promise<void>;
|
|
446
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
447
|
+
onMutateResult: OnMutateResult | undefined;
|
|
448
|
+
}) => void | Promise<void>;
|
|
313
449
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
314
450
|
urlParams: UrlParams<Url>;
|
|
315
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema
|
|
316
|
-
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
|
|
451
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
452
|
+
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
317
453
|
method: Method;
|
|
318
454
|
url: Url;
|
|
319
455
|
requestSchema: RequestSchema;
|
|
@@ -321,20 +457,36 @@ declare interface ClientInstance {
|
|
|
321
457
|
responseSchema: Response;
|
|
322
458
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
323
459
|
useContext?: () => Context;
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
460
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
461
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
462
|
+
onMutateResult: OnMutateResult | undefined;
|
|
463
|
+
}) => void | Promise<void>;
|
|
464
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
465
|
+
onMutateResult: OnMutateResult | undefined;
|
|
466
|
+
}) => void | Promise<void>;
|
|
467
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
468
|
+
onMutateResult: OnMutateResult | undefined;
|
|
469
|
+
}) => void | Promise<void>;
|
|
470
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
471
|
+
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
328
472
|
method: Method;
|
|
329
473
|
url: Url;
|
|
330
474
|
requestSchema: RequestSchema;
|
|
331
475
|
responseSchema: Response;
|
|
332
476
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
333
477
|
useContext?: () => Context;
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
478
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
479
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
480
|
+
onMutateResult: OnMutateResult | undefined;
|
|
481
|
+
}) => void | Promise<void>;
|
|
482
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
483
|
+
onMutateResult: OnMutateResult | undefined;
|
|
484
|
+
}) => void | Promise<void>;
|
|
485
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
486
|
+
onMutateResult: OnMutateResult | undefined;
|
|
487
|
+
}) => void | Promise<void>;
|
|
488
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
489
|
+
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
338
490
|
method: Method;
|
|
339
491
|
url: Url;
|
|
340
492
|
useKey: UseKey;
|
|
@@ -342,87 +494,159 @@ declare interface ClientInstance {
|
|
|
342
494
|
responseSchema: Response;
|
|
343
495
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
344
496
|
useContext?: () => Context;
|
|
345
|
-
|
|
346
|
-
|
|
497
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
498
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
499
|
+
onMutateResult: OnMutateResult | undefined;
|
|
500
|
+
}) => void | Promise<void>;
|
|
501
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
502
|
+
onMutateResult: OnMutateResult | undefined;
|
|
503
|
+
}) => void | Promise<void>;
|
|
504
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
505
|
+
onMutateResult: OnMutateResult | undefined;
|
|
506
|
+
}) => void | Promise<void>;
|
|
347
507
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
348
508
|
urlParams: UrlParams<Url>;
|
|
349
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined
|
|
350
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
509
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
510
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
351
511
|
config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
|
|
352
512
|
}, mutationOptions: {
|
|
353
513
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
354
514
|
useKey: UseKey;
|
|
355
515
|
useContext?: () => Context;
|
|
356
|
-
|
|
357
|
-
|
|
516
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
517
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
518
|
+
onMutateResult: OnMutateResult | undefined;
|
|
519
|
+
}) => void | Promise<void>;
|
|
520
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
521
|
+
onMutateResult: OnMutateResult | undefined;
|
|
522
|
+
}) => void | Promise<void>;
|
|
523
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
524
|
+
onMutateResult: OnMutateResult | undefined;
|
|
525
|
+
}) => void | Promise<void>;
|
|
358
526
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
359
527
|
urlParams: UrlParams<Url>;
|
|
360
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema
|
|
361
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown>(endpoint: {
|
|
528
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
|
|
529
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
362
530
|
config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
|
|
363
531
|
}, mutationOptions?: {
|
|
364
532
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
365
533
|
useContext?: () => Context;
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
534
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
535
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
536
|
+
onMutateResult: OnMutateResult | undefined;
|
|
537
|
+
}) => void | Promise<void>;
|
|
538
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
539
|
+
onMutateResult: OnMutateResult | undefined;
|
|
540
|
+
}) => void | Promise<void>;
|
|
541
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
542
|
+
onMutateResult: OnMutateResult | undefined;
|
|
543
|
+
}) => void | Promise<void>;
|
|
544
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
|
|
545
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
370
546
|
config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
|
|
371
547
|
}, mutationOptions: {
|
|
372
548
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
373
549
|
useKey: UseKey;
|
|
374
550
|
useContext?: () => Context;
|
|
375
|
-
|
|
376
|
-
|
|
551
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
552
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
553
|
+
onMutateResult: OnMutateResult | undefined;
|
|
554
|
+
}) => void | Promise<void>;
|
|
555
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
556
|
+
onMutateResult: OnMutateResult | undefined;
|
|
557
|
+
}) => void | Promise<void>;
|
|
558
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
559
|
+
onMutateResult: OnMutateResult | undefined;
|
|
560
|
+
}) => void | Promise<void>;
|
|
377
561
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
378
562
|
urlParams: UrlParams<Url>;
|
|
379
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined
|
|
380
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, Context = unknown>(endpoint: {
|
|
563
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, undefined>;
|
|
564
|
+
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
381
565
|
config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
|
|
382
566
|
}, mutationOptions?: {
|
|
383
567
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
384
568
|
useContext?: () => Context;
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
569
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
570
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
571
|
+
onMutateResult: OnMutateResult | undefined;
|
|
572
|
+
}) => void | Promise<void>;
|
|
573
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
574
|
+
onMutateResult: OnMutateResult | undefined;
|
|
575
|
+
}) => void | Promise<void>;
|
|
576
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
577
|
+
onMutateResult: OnMutateResult | undefined;
|
|
578
|
+
}) => void | Promise<void>;
|
|
579
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, undefined>;
|
|
580
|
+
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
389
581
|
config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
|
|
390
582
|
}, mutationOptions: {
|
|
391
583
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
392
584
|
useKey: UseKey;
|
|
393
585
|
useContext?: () => Context;
|
|
394
|
-
|
|
395
|
-
|
|
586
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
587
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
588
|
+
onMutateResult: OnMutateResult | undefined;
|
|
589
|
+
}) => void | Promise<void>;
|
|
590
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
591
|
+
onMutateResult: OnMutateResult | undefined;
|
|
592
|
+
}) => void | Promise<void>;
|
|
593
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
594
|
+
onMutateResult: OnMutateResult | undefined;
|
|
595
|
+
}) => void | Promise<void>;
|
|
396
596
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
397
597
|
urlParams: UrlParams<Url>;
|
|
398
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema
|
|
399
|
-
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown>(endpoint: {
|
|
598
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, QuerySchema>;
|
|
599
|
+
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
400
600
|
config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
|
|
401
601
|
}, mutationOptions?: {
|
|
402
602
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
403
603
|
useContext?: () => Context;
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
604
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
605
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
606
|
+
onMutateResult: OnMutateResult | undefined;
|
|
607
|
+
}) => void | Promise<void>;
|
|
608
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
609
|
+
onMutateResult: OnMutateResult | undefined;
|
|
610
|
+
}) => void | Promise<void>;
|
|
611
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
612
|
+
onMutateResult: OnMutateResult | undefined;
|
|
613
|
+
}) => void | Promise<void>;
|
|
614
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, undefined, QuerySchema>;
|
|
615
|
+
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
408
616
|
config: BaseStreamConfig<Method, Url, undefined, undefined>;
|
|
409
617
|
}, mutationOptions: {
|
|
410
618
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
411
619
|
useKey: UseKey;
|
|
412
620
|
useContext?: () => Context;
|
|
413
|
-
|
|
414
|
-
|
|
621
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
622
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
623
|
+
onMutateResult: OnMutateResult | undefined;
|
|
624
|
+
}) => void | Promise<void>;
|
|
625
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
626
|
+
onMutateResult: OnMutateResult | undefined;
|
|
627
|
+
}) => void | Promise<void>;
|
|
628
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
629
|
+
onMutateResult: OnMutateResult | undefined;
|
|
630
|
+
}) => void | Promise<void>;
|
|
415
631
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
416
632
|
urlParams: UrlParams<Url>;
|
|
417
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined
|
|
418
|
-
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown>(endpoint: {
|
|
633
|
+
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, undefined>;
|
|
634
|
+
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
419
635
|
config: BaseStreamConfig<Method, Url, undefined, undefined>;
|
|
420
636
|
}, mutationOptions?: {
|
|
421
637
|
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
422
638
|
useContext?: () => Context;
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
639
|
+
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
640
|
+
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
641
|
+
onMutateResult: OnMutateResult | undefined;
|
|
642
|
+
}) => void | Promise<void>;
|
|
643
|
+
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
644
|
+
onMutateResult: OnMutateResult | undefined;
|
|
645
|
+
}) => void | Promise<void>;
|
|
646
|
+
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
647
|
+
onMutateResult: OnMutateResult | undefined;
|
|
648
|
+
}) => void | Promise<void>;
|
|
649
|
+
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & StreamHelper<Method, Url, undefined, undefined>;
|
|
426
650
|
}
|
|
427
651
|
export { ClientInstance }
|
|
428
652
|
export { ClientInstance as ClientInstance_alias_1 }
|