[ Web Proxy ]
URL:
Viewing: https://firebase.google.com/docs/reference/js/firestore_pipelines.snapshotmetadata [Back]  [Original]
SnapshotMetadata class  |  Firebase JavaScript API reference Skip to main content
Firebase [Firebase]
Build Run Solutions Pricing Docs Support
Search:
Blog Go to console
Overview Fundamentals AI Build Run Reference Samples
Firebase [Firebase]
Send feedback

SnapshotMetadata class Stay organized with collections Save and categorize content based on your preferences.

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.

Send feedback

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-15 UTC.

Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-15 UTC."],[],[]]
Web Proxy Viewer  |  New URL  |  Original Page