Interface ResumableRealtimeSubscription<TFeature>

interface ResumableRealtimeSubscription<TFeature> {
    state: ResumableRealtimeState;
    close(reason?: string): void;
    enqueue(event: RealtimeSequencedEvent<TFeature>): Promise<ResumableRealtimeDelivery>;
    requireResnapshot(reason: RealtimeExternalResnapshotReason, detail?: string): void;
}

Type Parameters

TFeature = unknown

Index

Properties

Methods

close enqueue requireResnapshot

Properties

`Readonly`state

state: ResumableRealtimeState

Methods

close

close(reason?): void
Parameters
- Optionalreason: string
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/realtime/resumable.ts:141

enqueue

enqueue(event): Promise<ResumableRealtimeDelivery>
Parameters
- event: RealtimeSequencedEvent<TFeature>
Returns Promise<ResumableRealtimeDelivery>
- Defined in work/honua-sdk-js/honua-sdk-js/src/realtime/resumable.ts:138

requireResnapshot

requireResnapshot(reason, detail?): void
Project an adapter/server resume failure into an explicit snapshot transition.
Parameters
- reason: RealtimeExternalResnapshotReason
- Optionaldetail: string
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/realtime/resumable.ts:140