DocumentChange
は、クエリに一致するドキュメントに対する変更を表します。影響を受けるドキュメントと、発生した変更の種類が記載されます。
署名:
export declare interface DocumentChange<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
プロパティ
プロパティ | 型 | 説明 |
---|---|---|
ドキュメント | QueryDocumentSnapshot<AppModelType、DbModelType> | この変更の影響を受けるドキュメント。 |
newIndex | 数値 | この DocumentChange の直後の結果セット内の変更されたドキュメントのインデックス(前のすべての DocumentChange オブジェクトと現在の DocumentChange オブジェクトが適用されている場合)。-1(削除済み)できます。 |
oldIndex | 数値 | この DocumentChange の直前にある結果セット内の変更されたドキュメントのインデックス(以前の DocumentChange オブジェクトがすべて適用されている場合)。「追加」の場合は -1 できます。 |
type | DocumentChangeType | 変更のタイプ(「追加」、「変更」、「削除」)。 |
DocumentChange.doc
この変更の影響を受けるドキュメント。
署名:
readonly doc: QueryDocumentSnapshot<AppModelType, DbModelType>;
DocumentChange.newIndex
この DocumentChange
の直後の結果セット内の変更されたドキュメントのインデックス(前のすべての DocumentChange
オブジェクトと現在の DocumentChange
オブジェクトが適用されている場合)。-1(削除済み)できます。
署名:
readonly newIndex: number;
DocumentChange.oldIndex
この DocumentChange
の直前にある結果セット内の変更されたドキュメントのインデックス(以前の DocumentChange
オブジェクトがすべて適用されている場合)。「追加」の場合は -1
できます。
署名:
readonly oldIndex: number;
DocumentChange.type
変更のタイプ(「追加」、「変更」、「削除」)。
署名:
readonly type: DocumentChangeType;