QueryDocumentSnapshot class

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

QueryDocumentSnapshot提供与DocumentSnapshot相同的 API 界面。由于查询结果仅包含现有文档, exists属性将始终为 true,并且data()永远不会返回“未定义”。

签名:

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

扩展: DocumentSnapshot <应用程序模型类型,Db模型类型>

方法

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

QueryDocumentSnapshot.data()

Object检索文档中的所有字段

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

签名:

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

参数

范围类型描述
选项快照选项一个选项对象,用于配置如何从快照检索数据(例如,尚未设置为其最终值的服务器时间戳的所需行为)。

返回:

应用程序模型类型

包含文档中所有字段的Object