DocumentSnapshot
包含从 Firestore 数据库中的文档读取的数据。您可以使用 .data()
或 .get(<field>)
提取数据,以获取特定字段。
对于指向不存在文档的 DocumentSnapshot
,任何数据访问都将返回“undefined”。您可以使用 exists()
方法明确验证某个文档是否存在。
签名:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
构造函数
构造函数 | 修饰符 | 说明 |
---|---|---|
(构造函数)() | 构造 DocumentSnapshot 类的新实例 |
属性
属性 | 修饰符 | 类型 | 说明 |
---|---|---|---|
id | 字符串 | DocumentSnapshot 的属性,用于提供文档 ID。 |
|
参考 | DocumentReference<AppModelType, DbModelType> | DocumentSnapshot 中所含文档的 DocumentReference 。 |
方法
方法 | 修饰符 | 说明 |
---|---|---|
data() | 以 Object 的形式检索文档中的所有字段。如果文档不存在,则返回 undefined 。 |
|
exists() | 指示快照位置的文档是否存在。 | |
get(fieldPath) | 检索 fieldPath 指定的字段。如果文档或字段不存在,则返回 undefined 。 |
DocumentSnapshot.(构造函数)
构造 DocumentSnapshot
类的新实例
签名:
protected constructor();
文档快照.id
DocumentSnapshot
的属性,用于提供文档 ID。
签名:
get id(): string;
文档快照.ref
DocumentSnapshot
中所含文档的 DocumentReference
。
签名:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
以 Object
的形式检索文档中的所有字段。如果文档不存在,则返回 undefined
。
签名:
data(): AppModelType | undefined;
返回:
AppModelType |未定义
包含文档中的所有字段的 Object
;如果文档不存在,则返回 undefined
。
DocumentSnapshot.exists()
指示快照位置的文档是否存在。
签名:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
返回:
这是 QueryDocumentSnapshot<AppModelType, DbModelType>
如果文档存在,则返回 true。
DocumentSnapshot.get()
检索 fieldPath
指定的字段。如果文档或字段不存在,则返回 undefined
。
签名:
get(fieldPath: string | FieldPath): any;
参数
参数 | 类型 | 说明 |
---|---|---|
字段路径 | 字符串 |FieldPath | 特定字段的路径(例如“foo”或“foo.bar”)。 |
返回:
任意
位于指定字段位置的数据;如果文档中不存在此类字段,则未定义。