DocumentChange interface

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;