RoomSnapshot
See source codeTable of contents
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
clock
The current logical clock value for the room
clock: number
documentClock
optional
Clock value when document data was last changed (optional for backwards compatibility)
documentClock?: number
documents
Array of all document records with their last modification clocks
documents: Array<{
lastChangedClock: number
state: UnknownRecord
}>
schema
optional
Serialized schema used when creating this snapshot (optional)
schema?: SerializedSchema
tombstoneHistoryStartsAtClock
optional
Clock value where tombstone history begins - older deletions are not tracked (optional)
tombstoneHistoryStartsAtClock?: number
tombstones
optional
Map of deleted record IDs to their deletion clock values (optional)
tombstones?: Record<string, number>
Prev
UseSyncOptionsNext
RoomStoreMethods