MutationHookOptions

Defined in: react/src/types.ts:866

Options for useMutation hook. Extends React Query’s UseMutationOptions with invalidateQueries support.

Extends

• Omit<UseMutationOptions<ReactorReturnOk<Service, Method, Transform>, ReactorReturnErr<Service, Method, Transform>, ReactorArgs<Service, Method, Transform>, TOnMutateResult>, "mutationFn">

Type Parameters

Service

Service = BaseActor

Method

Method extends FunctionName<Service> = FunctionName<Service>

Transform

Transform extends TransformKey = "candid"

TOnMutateResult

TOnMutateResult = unknown

The value onMutate returns, which onSuccess, onError and onSettled receive. TypeScript infers it from onMutate.

Properties

invalidateQueries?

optional invalidateQueries?: InvalidationTarget<Service, Transform>[]

Defined in: react/src/types.ts:893

Queries to invalidate upon successful mutation, after the factory’s own invalidateQueries and before onSuccess. Takes the same entries: a query key, a query object or query factory, or a { functionName, args? } method of the mutation’s reactor; see InvalidationTarget.

Example

const balanceQuery = getIcpBalance([account])
useMutation({
  invalidateQueries: [balanceQuery],
})

---

onCanisterError?

optional onCanisterError?: (error, variables) => void

Defined in: react/src/types.ts:901

Callback for canister-level business logic errors. Called when the canister returns a Result { Err: E } variant.

Parameters

error

CanisterError<TransformReturnRegistry<ErrResult<ActorMethodReturnType<Service[Method]>>, Service>[Transform]>

The CanisterError containing the typed error value

variables

ReactorArgs<Service, Method, Transform>

The arguments passed to the mutation

Returns

void