Function useEndpointMutation

useEndpointMutation<
    TResponse,
    TPathParams extends Record<string, unknown> = Record<string, never>,
    TRequest = never,
    TQueryParams extends Record<string, unknown> = Record<string, never>,
>(
    config: EndpointConfig,
    pathParams?: MaybeRefOrGetter<
        Record<string, string | number | undefined>
        | null
        | undefined,
    >,
    options?: MutationOptions<TResponse, TPathParams, TRequest, TQueryParams>,
): MutationReturn<TResponse, TPathParams, TRequest, TQueryParams>
Execute a type-safe mutation (POST/PUT/PATCH/DELETE) with automatic cache management.

This is a low-level primitive — in normal usage it is called by the generated per-operation useMutation wrappers in api-client.ts, not directly.
Type Parameters
- TResponse
  The response data type
- TPathParams extends Record<string, unknown> = Record<string, never>
  The path parameters type (concrete, required values)
- TRequest = never
  The request body type (never if no body)
- TQueryParams extends Record<string, unknown> = Record<string, never>
  The query parameters type
Parameters
- config: EndpointConfig
  Endpoint config: axios instance, queryClient, path, method, listPath, operationsRegistry
- OptionalpathParams: MaybeRefOrGetter<Record<string, string | number | undefined> | null | undefined>
  Path parameters (reactive). Pass undefined for operations without path params.
- Optionaloptions: MutationOptions<TResponse, TPathParams, TRequest, TQueryParams>
  Mutation options (dontInvalidate, refetchEndpoints, etc.)
Returns MutationReturn<TResponse, TPathParams, TRequest, TQueryParams>
- Defined in openapi-mutation.ts:78

Function useEndpointMutation

Type Parameters

Parameters

Returns MutationReturn<TResponse, TPathParams, TRequest, TQueryParams>

Settings