Interface RealtimeFeatureState<TFeature>

interface RealtimeFeatureState<TFeature> {
    checkpoint?: RealtimeResumeCheckpoint;
    cursor?: string;
    deltaToken?: string;
    error?: unknown;
    ignoredEventCount: number;
    lastEventAt?: number;
    lastHeartbeatAt?: number;
    lastSequence?: number;
    lastStatusAt?: number;
    reconnectAttempt?: number;
    records: Readonly<Record<string, RealtimeFeatureRecord<TFeature>>>;
    retryAfterMs?: number;
    seenEventIds: readonly string[];
    staleSince?: number;
    status: RealtimeConnectionStatus;
    statusReason?: string;
    terminalError?: boolean;
    timestamp?: string;
    tombstones: Readonly<Record<string, RealtimeFeatureTombstone>>;
    watermark?: string;
}

Type Parameters

TFeature = unknown

Properties

`Optional` `Readonly`checkpoint

checkpoint?: RealtimeResumeCheckpoint

`Optional` `Readonly`cursor

cursor?: string

`Optional` `Readonly`deltaToken

deltaToken?: string

`Optional` `Readonly`error

error?: unknown

`Readonly`ignoredEventCount

ignoredEventCount: number

`Optional` `Readonly`lastEventAt

lastEventAt?: number

`Optional` `Readonly`lastHeartbeatAt

lastHeartbeatAt?: number

`Optional` `Readonly`lastSequence

lastSequence?: number

`Optional` `Readonly`lastStatusAt

lastStatusAt?: number

`Optional` `Readonly`reconnectAttempt

reconnectAttempt?: number

`Readonly`records

records: Readonly<Record<string, RealtimeFeatureRecord<TFeature>>>

`Optional` `Readonly`retryAfterMs

retryAfterMs?: number

`Readonly`seenEventIds

seenEventIds: readonly string[]

`Optional` `Readonly`staleSince

staleSince?: number

`Readonly`status

status: RealtimeConnectionStatus

`Optional` `Readonly`statusReason

statusReason?: string

`Optional` `Readonly`terminalError

terminalError?: boolean

`Optional` `Readonly`timestamp

timestamp?: string

`Readonly`tombstones

tombstones: Readonly<Record<string, RealtimeFeatureTombstone>>

`Optional` `Readonly`watermark

watermark?: string