Open History to see the last commit
1import React from 'react'
2β
3import { notifyManager } from '../core/notifyManager'
4import { noop, parseMutationArgs } from '../core/utils'
5import { MutationObserver } from '../core/mutationObserver'
6import { useQueryClient } from './QueryClientProvider'
7import {
8 UseMutateFunction,
9 UseMutationOptions,
10 UseMutationResult,
11} from './types'
12import { MutationFunction, MutationKey } from '../core/types'
13import { shouldThrowError } from './utils'
14β
15// HOOK
16β
17export function useMutation<
18 TData = unknown,
19 TError = unknown,
20 TVariables = void,
21 TContext = unknown
22>(
23 options: UseMutationOptions<TData, TError, TVariables, TContext>
24): UseMutationResult<TData, TError, TVariables, TContext>
25export function useMutation<
26 TData = unknown,
27 TError = unknown,
28 TVariables = void,
29 TContext = unknown
30>(
31 mutationFn: MutationFunction<TData, TVariables>,
32 options?: Omit<
33 UseMutationOptions<TData, TError, TVariables, TContext>,
34 'mutationFn'
35 >
36): UseMutationResult<TData, TError, TVariables, TContext>
37export function useMutation<
38 TData = unknown,
39 TError = unknown,
40 TVariables = void,
41 TContext = unknown
42>(
43 mutationKey: MutationKey,
44 options?: Omit<
45 UseMutationOptions<TData, TError, TVariables, TContext>,
46 'mutationKey'
47 >
48): UseMutationResult<TData, TError, TVariables, TContext>
49export function useMutation<
50 TData = unknown,
51 TError = unknown,
52 TVariables = void,
53 TContext = unknown
54>(
55 mutationKey: MutationKey,
56 mutationFn?: MutationFunction<TData, TVariables>,
57 options?: Omit<
58 UseMutationOptions<TData, TError, TVariables, TContext>,
59 'mutationKey' | 'mutationFn'
60 >
61): UseMutationResult<TData, TError, TVariables, TContext>
62export function useMutation<
63 TData = unknown,
64 TError = unknown,
65 TVariables = void,
66 TContext = unknown
67>(
68 arg1:
69 | MutationKey
70 | MutationFunction<TData, TVariables>
71 | UseMutationOptions<TData, TError, TVariables, TContext>,
72 arg2?:
73 | MutationFunction<TData, TVariables>
74 | UseMutationOptions<TData, TError, TVariables, TContext>,
75 arg3?: UseMutationOptions<TData, TError, TVariables, TContext>
76): UseMutationResult<TData, TError, TVariables, TContext> {
77 const mountedRef = React.useRef(false)
78 const [, forceUpdate] = React.useState(0)
79β
80 const options = parseMutationArgs(arg1, arg2, arg3)
81 const queryClient = useQueryClient()
82β
83 const obsRef = React.useRef<
84 MutationObserver<TData, TError, TVariables, TContext>
85 >()
86β
87 if (!obsRef.current) {
88 obsRef.current = new MutationObserver(queryClient, options)
89 } else {
90 obsRef.current.setOptions(options)
91 }
92β
93 const currentResult = obsRef.current.getCurrentResult()
94β
95 React.useEffect(() => {
96 mountedRef.current = true
97β
98 const unsubscribe = obsRef.current!.subscribe(
99 notifyManager.batchCalls(() => {
100 if (mountedRef.current) {
101 forceUpdate(x => x + 1)
102 }
103 })
104 )
105 return () => {
106 mountedRef.current = false
107 unsubscribe()
108 }
109 }, [])
110β
111 const mutate = React.useCallback<
112 UseMutateFunction<TData, TError, TVariables, TContext>
113 >((variables, mutateOptions) => {
114 obsRef.current!.mutate(variables, mutateOptions).catch(noop)
115 }, [])
116β
117 if (
118 currentResult.error &&
119 shouldThrowError(undefined, obsRef.current.options.useErrorBoundary, [
120 currentResult.error,
121 ])
122 ) {
123 throw currentResult.error
124 }
125β
126 return { ...currentResult, mutate, mutateAsync: currentResult.mutate }
127}