UseMutationOptions
Type Alias: UseMutationOptions<TData, TVariables>
Section titled “Type Alias: UseMutationOptions<TData, TVariables>”UseMutationOptions<
TData,TVariables> =RequestOptions<TData> &object
Defined in: packages/fetch-kit/src/react/use-mutation.ts:7
Options for useMutation.
Type Declaration
Section titled “Type Declaration”method?
Section titled “method?”
optionalmethod?:HttpMethod
HTTP method. Defaults to "POST".
onError?
Section titled “onError?”
optionalonError?: (error,variables) =>void
Called when the request errors.
Parameters
Section titled “Parameters”unknown
variables
Section titled “variables”TVariables
Returns
Section titled “Returns”void
onSettled?
Section titled “onSettled?”
optionalonSettled?: (data,error,variables) =>void
Called after success or error, regardless of outcome.
Parameters
Section titled “Parameters”TData | undefined
unknown
variables
Section titled “variables”TVariables
Returns
Section titled “Returns”void
onSuccess?
Section titled “onSuccess?”
optionalonSuccess?: (data,variables) =>void
Called on successful response.
Parameters
Section titled “Parameters”TData
variables
Section titled “variables”TVariables
Returns
Section titled “Returns”void
Type Parameters
Section titled “Type Parameters”TData
TVariables
Section titled “TVariables”TVariables