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