API reference · generated from source
Interface: IConvexQueryOnceClient#
Defined in: retree-convex/src/types.ts:175
Minimal Convex client one-off query surface needed by ConvexNode.
Extended by#
Methods#
query()#
query<Query>(query, args): Promise<Awaited<FunctionReturnType<Query>>>;Defined in: retree-convex/src/types.ts:183
Run a Convex query once without subscribing.
Type Parameters#
| Type Parameter |
|---|
Query extends QueryReference |
Parameters#
| Parameter | Type | Description |
|---|---|---|
query | Query | Convex query function reference. |
args | FunctionArgs<Query> | Query arguments. |
Returns#
Promise<Awaited<FunctionReturnType<Query>>>
Promise for the Convex query result.