DocumentSnapshot 包含从 Firestore 数据库中的文档读取的数据。您可以使用 .data() 或 .get(<field>) 提取数据，以获取特定字段。
对于指向不存在文档的 DocumentSnapshot，任何数据访问都将返回“undefined”。您可以使用 exists() 方法明确验证某个文档是否存在。
签名：
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
构造函数
| 构造函数 | 修饰符 | 说明 |
|---|---|---|
| (构造函数)() | 构造 DocumentSnapshot 类的新实例 |
属性
| 属性 | 修饰符 | 类型 | 说明 |
|---|---|---|---|
| id | 字符串 | DocumentSnapshot 的属性，用于提供文档 ID。 |
|
| 元数据 | SnapshotMetadata | 有关 DocumentSnapshot 的元数据，包括有关其来源和本地修改的信息。 |
|
| 参考 | DocumentReference<AppModelType, DbModelType> | DocumentSnapshot 中所含文档的 DocumentReference。 |
方法
| 方法 | 修饰符 | 说明 |
|---|---|---|
| data(options) | 以 Object 的形式检索文档中的所有字段。如果文档不存在，则返回 undefined。默认情况下，尚未设为最终值的 serverTimestamp() 值将以 null 的形式返回。您可以通过传递 options 对象来覆盖此方法。 |
|
| exists() | 返回数据是否存在。如果文档存在，则返回 true。 | |
| get(fieldPath, options) | 检索 fieldPath 指定的字段。如果文档或字段不存在，则返回 undefined。默认情况下，尚未设置为最终值的 serverTimestamp() 将返回 null。您可以通过传递 options 对象来覆盖此方法。 |
DocumentSnapshot.（构造函数）
构造 DocumentSnapshot 类的新实例
签名：
protected constructor();
文档快照.id
DocumentSnapshot 的属性，用于提供文档 ID。
签名：
get id(): string;
DocumentSnapshot.metadata
有关 DocumentSnapshot 的元数据，包括其来源和本地修改的相关信息。
签名：
readonly metadata: SnapshotMetadata;
文档快照.ref
DocumentSnapshot 中所含文档的 DocumentReference。
签名：
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
以 Object 的形式检索文档中的所有字段。如果文档不存在，则返回 undefined。
默认情况下，尚未设为最终值的 serverTimestamp() 值将返回为 null。您可以通过传递 options 对象来覆盖此方法。
签名：
data(options?: SnapshotOptions): AppModelType | undefined;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 选项 | SnapshotOptions | 一个选项对象，用于配置如何从快照中检索数据（例如，针对尚未设置为最终值的服务器时间戳的所需行为）。 |
返回：
AppModelType |未定义
包含文档中的所有字段的 Object；如果文档不存在，则返回 undefined。
DocumentSnapshot.exists()
返回数据是否存在。如果文档存在，则返回 true。
签名：
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
返回：
这是 QueryDocumentSnapshot<AppModelType, DbModelType>
DocumentSnapshot.get()
检索 fieldPath 指定的字段。如果文档或字段不存在，则返回 undefined。
默认情况下，尚未设置为最终值的 serverTimestamp() 将返回为 null。您可以通过传递 options 对象来覆盖此方法。
签名：
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 字段路径 | 字符串 |FieldPath | 特定字段的路径（例如“foo”或“foo.bar”）。 |
| 选项 | SnapshotOptions | 一个选项对象，用于配置如何从快照中检索字段（例如，尚未设为最终值的服务器时间戳的所需行为）。 |
返回：
任意
位于指定字段位置的数据；如果文档中不存在此类字段，则未定义。