UseReactorMutationParameters

Defined in: react/src/hooks/useActorMutation.ts:24

Extends

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

Type Parameters

Service

Service

Method

Method extends FunctionName<Service>

Transform

Transform extends TransformKey = "candid"

TOnMutateResult

TOnMutateResult = unknown

Properties

reactor

reactor: Reactor<Service, Transform>

Defined in: react/src/hooks/useActorMutation.ts:38

---

functionName

functionName: Method

Defined in: react/src/hooks/useActorMutation.ts:39

---

callConfig?

optional callConfig?: CallConfig

Defined in: react/src/hooks/useActorMutation.ts:40

---

invalidateQueries?

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

Defined in: react/src/hooks/useActorMutation.ts:50

Queries to invalidate upon successful mutation, awaited before onSuccess runs.

Each entry is a query key, a query object or query factory, or a { functionName, args? } method of reactor; see InvalidationTarget. undefined entries are skipped, so [maybeQuery] is safe when the optional query object is absent.

---

onCanisterError?

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

Defined in: react/src/hooks/useActorMutation.ts:56

Callback for canister-level business logic errors. Called when the canister returns a Result { Err: E } variant. Separate from onError, which fires for all errors including network failures.

Parameters

error

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

variables

ReactorArgs<Service, Method, Transform>

Returns

void