Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useMutation.ts

126 lines3.3 KB

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