Type Alias MutationOptions<TResponse, TPathParams, TRequest, TQueryParams>

MutationOptions: Omit<
    BaseMutationOptions<TResponse, TPathParams, TRequest, TQueryParams>,
    "mutationFn" | "mutationKey",
> & CacheInvalidationOptions & {
    axiosOptions?: AxiosRequestConfigExtended;
    queryParams?: ReactiveOr<TQueryParams>;
    serialize?: boolean | string;
}

Options for useMutation composable.

Type Parameters

TResponse
Response data type
TPathParams extends Record<string, unknown>
Path parameters type
TRequest
Request body type
TQueryParams extends Record<string, unknown> = Record<string, never>
Query parameters type

Type Declaration

OptionalaxiosOptions?: AxiosRequestConfigExtended
OptionalqueryParams?: ReactiveOr<TQueryParams>
Optionalserialize?: boolean | string
Serialise this mutation with others sharing the same scope: queued mutations run one at a time in submission order (TanStack scope). true derives the scope id from the operation's resolved path; a string is used as the scope id verbatim.

When path parameters are deferred to mutate-time, true falls back to the path template (e.g. serialize:PATCH:/pets/{petId}), serialising all mutations of that operation. For per-resource granularity with deferred params, supply path parameters at hook-time or use a string scope.

An explicit scope option from the caller always takes precedence over serialize. A warning is emitted when both are set.