API reference · generated from source
Interface: IConvexMutationClient#
Defined in: retree-convex/src/types.ts:141
Minimal Convex client mutation surface needed by Retree Convex mutation helpers.
Extended by#
Methods#
mutation()#
mutation<Mutation>(mutation, args): Promise<Awaited<FunctionReturnType<Mutation>>>;Defined in: retree-convex/src/types.ts:149
Run a Convex mutation.
Type Parameters#
| Type Parameter |
|---|
Mutation extends MutationReference |
Parameters#
| Parameter | Type | Description |
|---|---|---|
mutation | Mutation | Convex mutation function reference. |
args | FunctionArgs<Mutation> | Mutation arguments. |
Returns#
Promise<Awaited<FunctionReturnType<Mutation>>>
Promise for the Convex mutation result.