QuerySnapshot class

QuerySnapshot 包含零个或多个表示查询结果的 DocumentSnapshot 对象。您可以通过 docs 属性以数组的形式访问这些文档，也可以使用 forEach 方法枚举这些文档。您可以通过 empty 和 size 属性确定文档数量。

签名：

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

属性

属性	修饰符	类型	说明
文档		数组<QueryDocumentSnapshot<AppModelType, DbModelType>>	一个数组，表示 QuerySnapshot 中的所有文档。
empty		布尔值	如果 QuerySnapshot 中没有文档，则为 true。
元数据		SnapshotMetadata	有关此快照的元数据，有关其来源以及是否有本地修改的内容。
query		查询<AppModelType, DbModelType>	您针对其调用 get 或 onSnapshot 以获取此 QuerySnapshot 的查询。
size		数字	QuerySnapshot 中的文档数量。

方法

方法	修饰符	说明
docChanges(options)		返回自上次截取快照以来文档更改的数组。如果这是第一个快照，则所有文档都将在列表中显示为“已添加”更改。
foreach(callback, thisArg)		枚举 QuerySnapshot 中的所有文档。

QuerySnapshot.docs

一个数组，表示 QuerySnapshot 中的所有文档。

签名：

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

QuerySnapshot.empty

如果 QuerySnapshot 中没有文档，则为 true。

签名：

get empty(): boolean;

QuerySnapshot.metadata

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

签名：

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

您针对其调用 get 或 onSnapshot 以获取此 QuerySnapshot 的查询。

签名：

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

QuerySnapshot 中的文档数量。

签名：

get size(): number;

QuerySnapshot.docChanges()

返回自上次截取快照以来文档更改的数组。如果这是第一个快照，则所有文档都将在列表中显示为“已添加”更改。

签名：

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

参数

参数	类型	说明
选项	SnapshotListenOptions	SnapshotListenOptions，用于控制是否仅更改了元数据（即仅更改了 DocumentSnapshot.metadata）是否应触发快照事件。

返回：

数组<DocumentChange<AppModelType, DbModelType>>

QuerySnapshot.forEach()

枚举 QuerySnapshot 中的所有文档。

签名：

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

参数

参数	类型	说明
callback	（结果：QueryDocumentSnapshot<AppModelType, DbModelType>）=>无效	将通过 QueryDocumentSnapshot 针对快照中的每个文档调用的回调函数。
thisArg	未知	回调的 this 绑定。

返回：

void