Interface: IConvexQueryClient#

Defined in: retree-convex/src/types.ts:98

Minimal Convex client query surface needed by ConvexQueryNode.

Extended by#

IConvexClient

Methods#

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.

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.