useReactorMutation

useReactorMutation<Service, Method, Transform, TOnMutateResult>(__namedParameters): UseReactorMutationResult<Service, Method, Transform, TOnMutateResult>

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

Hook for executing mutation calls on a canister. Use this for component-level mutation flows. For non-React usage, prefer createMutation(...).execute(args).

Type Parameters

Service

Service

Method

Method extends string

Transform

Transform extends keyof TransformArgsRegistry<unknown> = "candid"

TOnMutateResult

TOnMutateResult = unknown

Parameters

__namedParameters

UseReactorMutationParameters<Service, Method, Transform, TOnMutateResult>

Returns

UseReactorMutationResult<Service, Method, Transform, TOnMutateResult>

Examples

const { mutate, isPending } = useActorMutation({
  reactor,
  functionName: "transfer",
  onSuccess: () => console.log("Success!"),
  onCanisterError: (err) => console.error("Canister Err:", err.code),
})

const transferMutation = createMutation(reactor, {
  functionName: "transfer",
  onCanisterError: (err) => console.error(err.code),
})

// Non-React execution path
await transferMutation.execute([{ to: "aaaaa-aa", amount: "100" }])