SnapshotListenOptions interface

結果セットに含める変更の種類を制御するために、onSnapshot() と QuerySnapshot.docChanges() に渡すオプション オブジェクト。

署名:

export declare interface SnapshotListenOptions

プロパティ

プロパティ 型 説明
includeMetadataChanges ブール値 クエリやドキュメントのメタデータのみが変更された場合でも、変更を含めます。デフォルトは false です。
source ListenSource クエリがリッスンするソースを設定します。デフォルトは「default」で、キャッシュとサーバーの両方をリッスンします。

SnapshotListenOptions.includeMetadataChanges

クエリやドキュメントのメタデータのみが変更された場合でも、変更を含めます。デフォルトは false です。

署名:

readonly includeMetadataChanges?: boolean;

SnapshotListenOptions.source

クエリがリッスンするソースを設定します。デフォルトは「default」で、キャッシュとサーバーの両方をリッスンします。

署名:

readonly source?: ListenSource;