Interface IConvexClient

Minimal Convex client surface accepted by ConvexNode.

interface IConvexClient {
    action<Action extends ActionReference>(
        action: Action,
        args: FunctionArgs<Action>,
    ): Promise<Awaited<FunctionReturnType<Action>>>;
    close(): Promise<void>;
    connectionState(): ConnectionState;
    mutation<Mutation extends MutationReference>(
        mutation: Mutation,
        args: FunctionArgs<Mutation>,
    ): Promise<Awaited<FunctionReturnType<Mutation>>>;
    onPaginatedUpdate_experimental<Query extends PaginatedQueryReference>(
        query: Query,
        args: PaginatedQueryArgs<Query>,
        options: { initialNumItems: number },
        callback: (
            result: RetreePaginatedQueryResult<PaginatedQueryItem<Query>>,
        ) => unknown,
        onError?: (error: Error) => unknown,
    ): IConvexQuerySubscription<
        RetreePaginatedQueryResult<PaginatedQueryItem<Query>>
        | undefined,
    >;
    onUpdate<Query extends QueryReference>(
        query: Query,
        args: FunctionArgs<Query>,
        callback: (result: FunctionReturnType<Query>) => unknown,
        onError?: (error: Error) => unknown,
    ): IConvexQuerySubscription<FunctionReturnType<Query>>;
    query<Query extends QueryReference>(
        query: Query,
        args: FunctionArgs<Query>,
    ): Promise<Awaited<FunctionReturnType<Query>>>;
    subscribeToConnectionState(
        callback: (connectionState: ConnectionState) => void,
    ): () => void;
}

Hierarchy (View Summary)

Index

Methods

action close connectionState mutation onPaginatedUpdate_experimental onUpdate query subscribeToConnectionState

Methods

action

action<Action extends ActionReference>(
action: Action,
args: FunctionArgs<Action>,
): Promise<Awaited<FunctionReturnType<Action>>>
Run a Convex action.
Type Parameters
- Action extends ActionReference
Parameters
- action: Action
  Convex action function reference.
- args: FunctionArgs<Action>
  Action arguments.
Returns Promise<Awaited<FunctionReturnType<Action>>>
Promise for the Convex action result.
Inherited from IConvexActionClient.action
- Defined in retree-convex/src/types.ts:166

close

close(): Promise<void>
Close the underlying Convex client.

Returns Promise<void>
- Defined in retree-convex/src/types.ts:218

connectionState

connectionState(): ConnectionState
Get the current connection state.

Returns ConnectionState
Inherited from IConvexConnectionClient.connectionState
- Defined in retree-convex/src/types.ts:197

mutation

mutation<Mutation extends MutationReference>(
mutation: Mutation,
args: FunctionArgs<Mutation>,
): Promise<Awaited<FunctionReturnType<Mutation>>>
Run a Convex mutation.
Type Parameters
- Mutation extends MutationReference
Parameters
- 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
- Defined in retree-convex/src/types.ts:149

onPaginatedUpdate_experimental

onPaginatedUpdate_experimental<Query extends PaginatedQueryReference>(
    query: Query,
    args: PaginatedQueryArgs<Query>,
    options: { initialNumItems: number },
    callback: (
        result: RetreePaginatedQueryResult<PaginatedQueryItem<Query>>,
    ) => unknown,
    onError?: (error: Error) => unknown,
): IConvexQuerySubscription<
    RetreePaginatedQueryResult<PaginatedQueryItem<Query>>
    | undefined,
>
Subscribe to a paginated Convex query and receive emitted values.
Type Parameters
- Query extends PaginatedQueryReference
Parameters
- query: Query
  Convex paginated query function reference.
- args: PaginatedQueryArgs<Query>
  Query arguments excluding paginationOpts.
- options: { initialNumItems: number }
  Paginated query options.
- callback: (result: RetreePaginatedQueryResult<PaginatedQueryItem<Query>>) => unknown
  Called when Convex emits a new paginated query result.
- OptionalonError: (error: Error) => unknown
  Optional callback for subscription errors.
Returns IConvexQuerySubscription<
RetreePaginatedQueryResult<PaginatedQueryItem<Query>>
| undefined,
>
Subscription handle used by ConvexPaginatedQueryNode.dispose.
Inherited from IConvexQueryClient.onPaginatedUpdate_experimental
- Defined in retree-convex/src/types.ts:125

onUpdate

onUpdate<Query extends QueryReference>(
    query: Query,
    args: FunctionArgs<Query>,
    callback: (result: FunctionReturnType<Query>) => unknown,
    onError?: (error: Error) => unknown,
): IConvexQuerySubscription<FunctionReturnType<Query>>
Subscribe to a Convex query and receive emitted values.
Type Parameters
- Query extends QueryReference
Parameters
- query: Query
  Convex query function reference.
- args: FunctionArgs<Query>
  Query arguments.
- callback: (result: FunctionReturnType<Query>) => unknown
  Called when Convex emits a new query result.
- OptionalonError: (error: Error) => unknown
  Optional callback for subscription errors.
Returns IConvexQuerySubscription<FunctionReturnType<Query>>
Subscription handle used by ConvexQueryNode.dispose.
Inherited from IConvexQueryClient.onUpdate
- Defined in retree-convex/src/types.ts:108

query

query<Query extends QueryReference>(
query: Query,
args: FunctionArgs<Query>,
): Promise<Awaited<FunctionReturnType<Query>>>
Run a Convex query once without subscribing.
Type Parameters
- Query extends QueryReference
Parameters
- query: Query
  Convex query function reference.
- args: FunctionArgs<Query>
  Query arguments.
Returns Promise<Awaited<FunctionReturnType<Query>>>
Promise for the Convex query result.
Inherited from IConvexQueryOnceClient.query
- Defined in retree-convex/src/types.ts:183

subscribeToConnectionState

subscribeToConnectionState(
callback: (connectionState: ConnectionState) => void,
): () => void
Subscribe to connection state changes.
Parameters
- callback: (connectionState: ConnectionState) => void
Returns () => void
Inherited from IConvexConnectionClient.subscribeToConnectionState
- Defined in retree-convex/src/types.ts:201

Interface IConvexClient

Hierarchy (View Summary)

Index

Methods

Methods

action

Type Parameters

Parameters

Returns Promise<Awaited<FunctionReturnType<Action>>>

close

Returns Promise<void>

connectionState

Returns ConnectionState

mutation

Type Parameters

Parameters

Returns Promise<Awaited<FunctionReturnType<Mutation>>>

onPaginatedUpdate_experimental

Type Parameters

Parameters

Returns IConvexQuerySubscription<
RetreePaginatedQueryResult<PaginatedQueryItem<Query>>
| undefined,
>

onUpdate

Type Parameters

Parameters

Returns IConvexQuerySubscription<FunctionReturnType<Query>>

query

Type Parameters

Parameters

Returns Promise<Awaited<FunctionReturnType<Query>>>

subscribeToConnectionState

Parameters

Returns () => void

Settings

On This Page

Interface IConvexClient

Hierarchy (View Summary)

Index

Methods

Methods

action

Type Parameters

Parameters

Returns Promise<Awaited<FunctionReturnType<Action>>>

close

Returns Promise<void>

connectionState

Returns ConnectionState

mutation

Type Parameters

Parameters

Returns Promise<Awaited<FunctionReturnType<Mutation>>>

onPaginatedUpdate_experimental

Type Parameters

Parameters

Returns IConvexQuerySubscription< RetreePaginatedQueryResult<PaginatedQueryItem<Query>> | undefined,>

onUpdate

Type Parameters

Parameters

Returns IConvexQuerySubscription<FunctionReturnType<Query>>

query

Type Parameters

Parameters

Returns Promise<Awaited<FunctionReturnType<Query>>>

subscribeToConnectionState

Parameters

Returns () => void

Settings

On This Page

Returns IConvexQuerySubscription<
RetreePaginatedQueryResult<PaginatedQueryItem<Query>>
| undefined,
>