The Firebase JS SDK is now in BETA!
This EAP site is no longer maintained. See the official Firebase Documentation site for the latest documentation and information about the Firebase JS SDK.

Home > @firebase/firestore > / > SnapshotListenOptions

SnapshotListenOptions interface

An options object that can be passed to onSnapshot() and QuerySnapshot.docChanges() to control which types of changes to include in the result set.

Signature:

export declare interface SnapshotListenOptions 

Properties

Property Type Description
includeMetadataChanges? boolean (Optional) Include a change even if only the metadata of the query or of a document changed. Default is false.