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

Index

Properties

Methods

Properties

fromCache

fromCache: boolean

True if the snapshot was created from cached data rather than guaranteed up-to-date server data. If your listener has opted into metadata updates (via SnapshotListenOptions) you will receive another snapshot with fromCache set to false once the client has received up-to-date data from the backend.

hasPendingWrites

hasPendingWrites: boolean

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.

Methods

isEqual

  • isEqual(other: SnapshotMetadata): boolean
  • Returns true if this SnapshotMetadata is equal to the provided one.

    Parameters

    Returns boolean

    true if this SnapshotMetadata is equal to the provided one.