DocumentSnapshot class

DocumentSnapshot包含从 Firestore 数据库中的文档读取的数据。可以使用.data()或.get(<field>)提取数据以获取特定字段。

对于指向不存在文档的DocumentSnapshot ，任何数据访问都将返回“未定义”。您可以使用exists()方法显式验证文档是否存在。

签名：

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

构造函数

特性

方法

文档快照。（构造函数）

构造DocumentSnapshot类的新实例

签名：

protected constructor();

文档快照.id

提供文档 ID 的DocumentSnapshot属性。

签名：

get id(): string;

文档快照.元数据

有关DocumentSnapshot的元数据，包括有关其来源和本地修改的信息。

签名：

readonly metadata: SnapshotMetadata;

文档快照.ref

DocumentSnapshot中包含的文档的DocumentReference 。

签名：

get ref(): DocumentReference<AppModelType, DbModelType>;

文档快照.data()

以Object检索文档中的所有字段。如果文档不存在，则返回undefined 。

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

签名：

data(options?: SnapshotOptions): AppModelType | undefined;

参数

返回：

应用程序模型类型 |不明确的

包含文档中所有字段的Object ，如果文档不存在则undefined 。

DocumentSnapshot.exists()

返回数据是否存在。如果文档存在则为 true。

签名：

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

返回：

这是QueryDocumentSnapshot <应用程序模型类型，Db模型类型>

文档快照.get()

检索fieldPath指定的字段。如果文档或字段不存在，则返回undefined 。

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

签名：

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

参数

返回：

任何

指定字段位置处的数据；如果文档中不存在此类字段，则数据未定义。