Interface IConvexQueryClient

Minimal Convex client query surface needed by ConvexQueryNode.

interface IConvexQueryClient {
    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>>;
}

Hierarchy (View Summary)

IConvexQueryClient
- IConvexClient

Index

Methods

onPaginatedUpdate_experimental onUpdate

Methods

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.
- 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.
- Defined in retree-convex/src/types.ts:108