SnapshotMetadata

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

class SnapshotMetadata {

private constructor();

readonly fromCache: boolean;

readonly hasPendingWrites: boolean;

isEqual(other: SnapshotMetadata): boolean;

}

§Constructors

new SnapshotMetadata() private

[src]

§Properties

fromCache: boolean

[src]

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: boolean

[src]

True if the snapshot contains the result of local writes (for example 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(other: SnapshotMetadata): boolean

[src]

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

@param other

The SnapshotMetadata to compare against.

@return

true if this SnapshotMetadata is equal to the provided one.