QuerySnapshot class

QuerySnapshot包含零个或多个表示查询结果的DocumentSnapshot对象。文档可以通过docs属性作为数组进行访问,也可以使用forEach方法进行枚举。文档的数量可以通过emptysize属性来确定。

签名:

export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

特性

财产修饰符类型描述
文档数组<查询文档快照<应用程序模型类型,Db模型类型>> QuerySnapshot中所有文档的数组。
空的布尔值如果QuerySnapshot中没有文档,则为 True。
元数据快照元数据有关此快照的元数据,涉及其来源以及是否有本地修改。
询问询问<应用程序模型类型,Db模型类型>您调用getonSnapshot来获取此QuerySnapshot的查询。
尺寸数字QuerySnapshot中的文档数量。

方法

方法修饰符描述
文档更改(选项)返回自上次快照以来文档更改的数组。如果这是第一个快照,则所有文档都将作为“添加”更改出现在列表中。
forEach(回调,thisArg)枚举QuerySnapshot中的所有文档。

查询快照.docs

QuerySnapshot中所有文档的数组

签名:

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

查询快照.空

如果QuerySnapshot中没有文档,则为 True

签名:

get empty(): boolean;

查询快照.元数据

有关此快照的元数据,涉及其来源以及是否有本地修改。

签名:

readonly metadata: SnapshotMetadata;

查询快照.query

您调用getonSnapshot以获得此QuerySnapshot的查询

签名:

readonly query: Query<AppModelType, DbModelType>;

查询快照大小

QuerySnapshot中的文档数量

签名:

get size(): number;

QuerySnapshot.docChanges()

返回自上次快照以来文档更改的数组。如果这是第一个快照,则所有文档都将作为“添加”更改出现在列表中。

签名:

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

参数

范围类型描述
选项快照监听选项SnapshotListenOptions控制仅元数据更改(即仅更改DocumentSnapshot.metadata )是否应触发快照事件。

返回:

数组<文档更改<应用程序模型类型,Db模型类型>>

QuerySnapshot.forEach()

枚举QuerySnapshot中的所有文档

签名:

forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;

参数

范围类型描述
打回来(结果:查询文档快照<AppModelType, DbModelType>) => void对于快照中的每个文档,使用QueryDocumentSnapshot调用回调。
这个参数未知回调的this绑定。

返回:

空白