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	Include a change even if only the metadata of the query or of a document changed. Default is false.
source	ListenSource	Set the source the query listens to. Default to "default", which listens to both cache and server.

Include a change even if only the metadata of the query or of a document changed. Default is false.

Signature:

readonly includeMetadataChanges?: boolean;

Set the source the query listens to. Default to "default", which listens to both cache and server.

Signature:

readonly source?: ListenSource;

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 2024-03-14 UTC.