Jump to top

SnapshotMetadata

interface

Metadata about a snapshot, describing the state of the snapshot.

Properties

fromCache

</>

True if the snapshot includes local writes (set() or update() calls) that haven't been committed to the backend yet. If your listener has opted into metadata updates (via SnapshotListenOptions) you will receive another snapshot with fromCache equal to false once the client has received up-to-date data from the backend.

fromCache: boolean;

hasPendingWrites

</>

True if the snapshot contains the result of local writes (e.g. set() or update() calls) that have not yet been committed to the backend. If your listener has opted into metadata updates (via SnapshotListenOptions) you will receive another snapshot with hasPendingWrites equal to false once the writes have been committed to the backend.

hasPendingWrites: boolean;

Methods

isEqual

</>

Returns true if this SnapshotMetadata is equal to the provided one.

isEqual(other: SnapshotMetadata): boolean;