API reference · generated from source
Interface: IConvexClient#
Defined in: retree-convex/src/types.ts:209
Minimal Convex client surface accepted by ConvexNode.
Extends#
IConvexQueryClient.IConvexMutationClient.IConvexActionClient.IConvexQueryOnceClient.IConvexConnectionClient
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.
Inherited from#
close()#
close(): Promise<void>;Defined in: retree-convex/src/types.ts:218
Close the underlying Convex client.
Returns#
Promise<void>
connectionState()#
connectionState(): ConnectionState;Defined in: retree-convex/src/types.ts:197
Get the current connection state.
Returns#
ConnectionState
Inherited from#
IConvexConnectionClient.connectionState
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.
Inherited from#
IConvexMutationClient.mutation
onPaginatedUpdate_experimental()#
onPaginatedUpdate_experimental<Query>(
query,
args,
options,
callback,
onError?): IConvexQuerySubscription<
| RetreePaginatedQueryResult<PaginatedQueryItem<Query>>
| undefined>;Defined in: retree-convex/src/types.ts:125
Subscribe to a paginated Convex query and receive emitted values.
Type Parameters#
| Type Parameter |
|---|
Query extends PaginatedQueryReference |
Parameters#
| Parameter | Type | Description |
|---|---|---|
query | Query | Convex paginated query function reference. |
args | PaginatedQueryArgs<Query> | Query arguments excluding paginationOpts. |
options | { initialNumItems: number; } | Paginated query options. |
options.initialNumItems | number | - |
callback | (result) => unknown | Called when Convex emits a new paginated query result. |
onError? | (error) => unknown | Optional callback for subscription errors. |
Returns#
IConvexQuerySubscription<
| RetreePaginatedQueryResult<PaginatedQueryItem<Query>>
| undefined>
Subscription handle used by ConvexPaginatedQueryNode.dispose.
Inherited from#
IConvexQueryClient.onPaginatedUpdate_experimental
onUpdate()#
onUpdate<Query>(
query,
args,
callback,
onError?): IConvexQuerySubscription<FunctionReturnType<Query>>;Defined in: retree-convex/src/types.ts:108
Subscribe to a Convex query and receive emitted values.
Type Parameters#
| Type Parameter |
|---|
Query extends QueryReference |
Parameters#
| Parameter | Type | Description |
|---|---|---|
query | Query | Convex query function reference. |
args | FunctionArgs<Query> | Query arguments. |
callback | (result) => unknown | Called when Convex emits a new query result. |
onError? | (error) => unknown | Optional callback for subscription errors. |
Returns#
IConvexQuerySubscription<FunctionReturnType<Query>>
Subscription handle used by ConvexQueryNode.dispose.
Inherited from#
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.
Inherited from#
subscribeToConnectionState()#
subscribeToConnectionState(callback): () => void;Defined in: retree-convex/src/types.ts:201
Subscribe to connection state changes.
Parameters#
| Parameter | Type |
|---|---|
callback | (connectionState) => void |
Returns#
() => void