QueryDocumentSnapshot class

QueryDocumentSnapshot 包含作为查询的一部分从 Firestore 数据库的文档读取的数据。该文档一定会存在,并且可以使用 .data().get(<field>) 提取其数据以获取特定字段。

QueryDocumentSnapshot 提供与 DocumentSnapshot 相同的 API Surface。由于查询结果仅包含现有文档,因此 exists 属性将始终为 true,而 data() 绝不会返回“undefined”。

签名

export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType> 

扩展DocumentSnapshot<AppModelType, DbModelType>

方法

方法 修饰符 说明
data(options) Object 的形式检索文档中的所有字段。默认情况下,尚未设置为最终值的 serverTimestamp() 值将以 null 的形式返回。您可以通过传递 options 对象来覆盖此方法。

QueryDocumentSnapshot.data()

Object 的形式检索文档中的所有字段。

默认情况下,尚未设为最终值的 serverTimestamp() 值将返回为 null。您可以通过传递 options 对象来覆盖此方法。

签名

/** @override */
data(options?: SnapshotOptions): AppModelType;

参数

参数 类型 说明
选项 SnapshotOptions 一个选项对象,用于配置如何从快照中检索数据(例如,针对尚未设置为最终值的服务器时间戳的所需行为)。

返回

应用模型类型

包含文档中的所有字段的 Object