RoomSnapshot

Snapshot of a room's complete state that can be persisted and restored. Contains all documents, tombstones, and metadata needed to reconstruct the room.

interface RoomSnapshot {}

Properties

The current logical clock value for the room

clock?: number;

Clock value when document data was last changed (optional for backwards compatibility)

documentClock?: number;

Array of all document records with their last modification clocks

documents: Array<{
  lastChangedClock: number;
  state: UnknownRecord;
}>;

Serialized schema used when creating this snapshot (optional)

schema?: SerializedSchema;

Clock value where tombstone history begins - older deletions are not tracked (optional)

tombstoneHistoryStartsAtClock?: number;

Map of deleted record IDs to their deletion clock values (optional)

tombstones?: Record<string, number>;