Subscription

Defined in: packages/db/src/types.ts:284

Public interface for a collection subscription Used by sync implementations to track subscription lifecycle

Extends#

• EventEmitter<SubscriptionEvents>

Properties#

lastError#

readonly lastError: unknown;

Defined in: packages/db/src/types.ts:288

Most recent subset-load failure observed by this subscription.

status#

readonly status: SubscriptionStatus;

Defined in: packages/db/src/types.ts:286

Current status of the subscription

Methods#

clearListeners()#

protected clearListeners(): void;

Defined in: packages/db/src/event-emitter.ts:164

Clear all listeners

Returns#

void

Inherited from#

EventEmitter.clearListeners

emitInner()#

protected emitInner<T>(event, eventPayload): void;

Defined in: packages/db/src/event-emitter.ts:132

Internal

Emit an event to all listeners

Type Parameters#

T#

T extends keyof SubscriptionEvents

Parameters#

event#

T

Event name to emit

eventPayload#

SubscriptionEvents[T]

Event payload For use by subclasses - subclasses should wrap this with a public emit if needed

Returns#

void

Inherited from#

EventEmitter.emitInner

emitInnerWhile()#

protected emitInnerWhile<T>(
   event, 
   eventPayload, 
   isCurrent): void;

Defined in: packages/db/src/event-emitter.ts:140

Emit until a reentrant callback invalidates the event being delivered.

Type Parameters#

T#

T extends keyof SubscriptionEvents

Parameters#

event#

T

eventPayload#

SubscriptionEvents[T]

isCurrent#

() => boolean

Returns#

void

Inherited from#

EventEmitter.emitInnerWhile

off()#

off<T>(event, callback): void;

Defined in: packages/db/src/event-emitter.ts:74

Unsubscribe from an event

Type Parameters#

T#

T extends keyof SubscriptionEvents

Parameters#

event#

T

Event name to stop listening for

callback#

(event) => void

Function to remove

Returns#

void

Inherited from#

EventEmitter.off

on()#

on<T>(event, callback): () => void;

Defined in: packages/db/src/event-emitter.ts:23

Subscribe to an event

Type Parameters#

T#

T extends keyof SubscriptionEvents

Parameters#

event#

T

Event name to listen for

callback#

(event) => void

Function to call when event is emitted

Returns#

Unsubscribe function

(): void;

Returns#

void

Inherited from#

EventEmitter.on

once()#

once<T>(event, callback): () => void;

Defined in: packages/db/src/event-emitter.ts:52

Subscribe to an event once (automatically unsubscribes after first emission)

Type Parameters#

T#

T extends keyof SubscriptionEvents

Parameters#

event#

T

Event name to listen for

callback#

(event) => void

Function to call when event is emitted

Returns#

Unsubscribe function

(): void;

Returns#

void

Inherited from#

EventEmitter.once

waitFor()#

waitFor<T>(event, timeout?): Promise<SubscriptionEvents[T]>;

Defined in: packages/db/src/event-emitter.ts:96

Wait for an event to be emitted

Type Parameters#

T#

T extends keyof SubscriptionEvents

Parameters#

event#

T

Event name to wait for

timeout?#

number

Optional timeout in milliseconds

Returns#

Promise<SubscriptionEvents[T]>

Promise that resolves with the event payload

Inherited from#

EventEmitter.waitFor