Interface IConvexQuerySubscription<T>

Subscription handle returned by a Convex query client.

interface IConvexQuerySubscription<T> {
    getCurrentValue(): T | undefined;
    unsubscribe(): void;
    (): void;
}

Type Parameters

T

IConvexQuerySubscription(): void
Returns void
- Defined in retree-convex/src/types.ts:84

Index

Methods

getCurrentValue unsubscribe

Methods

getCurrentValue

getCurrentValue(): T | undefined
Get the latest synchronously available query value, if Convex has one.

Returns T | undefined
- Defined in retree-convex/src/types.ts:92

unsubscribe

unsubscribe(): void
Stop listening to query updates.

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