MCPcopy Create free account
hub / github.com/TanStack/query / useMutation

Function useMutation

packages/react-query/src/useMutation.ts:187–241  ·  view source on GitHub ↗
(
  options: UseMutationOptions<TData, TError, TVariables, TOnMutateResult>,
  queryClient?: QueryClient,
)

Source from the content-addressed store, hash-verified

185 * ```
186 */
187export function useMutation<
188 TData = unknown,
189 TError = DefaultError,
190 TVariables = void,
191 TOnMutateResult = unknown,
192>(
193 options: UseMutationOptions<TData, TError, TVariables, TOnMutateResult>,
194 queryClient?: QueryClient,
195): UseMutationResult<TData, TError, TVariables, TOnMutateResult> {
196 const client = useQueryClient(queryClient)
197
198 const [observer] = React.useState(
199 () =>
200 new MutationObserver<TData, TError, TVariables, TOnMutateResult>(
201 client,
202 options,
203 ),
204 )
205
206 React.useEffect(() => {
207 observer.setOptions(options)
208 }, [observer, options])
209
210 const result = React.useSyncExternalStore(
211 React.useCallback(
212 (onStoreChange) =>
213 observer.subscribe(notifyManager.batchCalls(onStoreChange)),
214 [observer],
215 ),
216 () => observer.getCurrentResult(),
217 () => observer.getCurrentResult(),
218 )
219
220 const mutate = React.useCallback<
221 UseMutateFunction<TData, TError, TVariables, TOnMutateResult>
222 >(
223 (
224 ...args: Parameters<
225 UseMutateFunction<TData, TError, TVariables, TOnMutateResult>
226 >
227 ) => {
228 observer.mutate(args[0] as TVariables, args[1]).catch(noop)
229 },
230 [observer],
231 )
232
233 if (
234 result.error &&
235 shouldThrowError(observer.options.throwOnError, [result.error])
236 ) {
237 throw result.error
238 }
239
240 return { ...result, mutate, mutateAsync: result.mutate }
241}

Callers 15

ExampleWithUnknownKeyFunction · 0.90
ExamplesFunction · 0.90
ExamplesFunction · 0.90
ExampleWithStringLiteralFunction · 0.90

Calls 6

useQueryClientFunction · 0.90
shouldThrowErrorFunction · 0.90
setOptionsMethod · 0.45
subscribeMethod · 0.45
getCurrentResultMethod · 0.45
mutateMethod · 0.45

Tested by 9

MutationsFunction · 0.40
PageFunction · 0.40
DatesFunction · 0.40
MutateFunction · 0.40
PageFunction · 0.40
MutatesFunction · 0.40
ComponentFunction · 0.40
PageFunction · 0.40
MutationFunction · 0.40