Interface: RetreeConvexMutation()<Mutation>#

Defined in: retree-convex/src/types.ts:253

Typed function wrapper around a Convex mutation.

Type Parameters#

Type Parameter	Default type
`Mutation` extends `MutationReference`	`MutationReference`

RetreeConvexMutation(args, options?): Promise<Awaited<FunctionReturnType<Mutation>>>;

Defined in: retree-convex/src/types.ts:263

Run the Convex mutation.

Parameter	Type	Description
`args`	`FunctionArgs`<`Mutation`>	Mutation arguments.
`options?`	`RetreeConvexMutationOptions`<`Mutation`>	Optional optimistic update hook.

Promise<Awaited<FunctionReturnType<Mutation>>>

Promise for the Convex mutation result.