Interface RealtimeSnapshotEvent<TFeature>

interface RealtimeSnapshotEvent<TFeature> {
    checkpoint?: RealtimeResumeCheckpoint;
    cursor?: string;
    deltaToken?: string;
    eventId?: string;
    features: readonly RealtimeFeaturePatch<TFeature>[];
    receivedAt?: number;
    replace?: boolean;
    sequence?: number;
    timestamp?: string;
    type: "snapshot";
    watermark?: string;
}

Type Parameters

  • TFeature = unknown

Hierarchy (view full)

Properties

checkpoint? cursor? deltaToken? eventId? features receivedAt? replace? sequence? timestamp? type watermark?

Properties

Optional Readonlycheckpoint

checkpoint?: RealtimeResumeCheckpoint

Optional Readonlycursor

cursor?: string

Optional ReadonlydeltaToken

deltaToken?: string

Optional ReadonlyeventId

eventId?: string

Readonlyfeatures

features: readonly RealtimeFeaturePatch<TFeature>[]

Optional ReadonlyreceivedAt

receivedAt?: number

Optional Readonlyreplace

replace?: boolean

Replace the current live set.

Default

true

Optional Readonlysequence

sequence?: number

Optional Readonlytimestamp

timestamp?: string

Readonlytype

type

Optional Readonlywatermark

watermark?: string

Settings

Member Visibility

On This Page

Properties