Interface: IConvexQuerySubscription()<T>#

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

Subscription handle returned by a Convex query client.

Type Parameters#

IConvexQuerySubscription(): void;

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

Subscription handle returned by a Convex query client.

Returns#

void

Methods#

getCurrentValue()#

getCurrentValue(): T | undefined;

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

Get the latest synchronously available query value, if Convex has one.

Returns#

T | undefined

unsubscribe()#

unsubscribe(): void;

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

Stop listening to query updates.

Returns#

void