firebase-js-sdk/docs-devsite/firestore_.snapshotmetadata.md

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

SnapshotMetadata class

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

Signature:

export declare class SnapshotMetadata 

Properties

Property	Modifiers	Type	Description
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		boolean	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

Method	Modifiers	Description
isEqual(other)		Returns true if this SnapshotMetadata is equal to the provided one.

SnapshotMetadata.fromCache

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.

Signature:

readonly fromCache: boolean;

SnapshotMetadata.hasPendingWrites

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.

Signature:

readonly hasPendingWrites: boolean;

SnapshotMetadata.isEqual()

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

Signature:

isEqual(other: SnapshotMetadata): boolean;

Parameters

Parameter	Type	Description
other	SnapshotMetadata	The SnapshotMetadata to compare against.

Returns:

boolean

true if this SnapshotMetadata is equal to the provided one.