DocumentReference class

DocumentReference 是指文档在 Firestore 数据库中的位置，可用于写入、读取或监听该位置。引用位置的文件可能不存在。

签名：

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

属性

属性	修饰符	类型	说明
转化者		FirestoreDataConverter<AppModelType, DbModelType>|null	与此实例关联的 FirestoreDataConverter（如果提供）。
firestore		Firestore	文档所在的 Firestore 实例。这对于执行事务非常有用。
id		字符串	文档集合中的标识符。
parent		CollectionReference<AppModelType, DbModelType>	此DocumentReference所属的集合。
path		字符串	一个字符串，表示参考文档的路径（相对于数据库的根目录）。
type		（未声明）	此 Firestore 引用的类型。

方法

方法	修饰符	说明
withConverter(converter)		将自定义数据转换器应用于此 DocumentReference，这样您就可以将自己的自定义模型对象用于 Firestore。当您使用返回的 DocumentReference 实例调用 setDoc()、getDoc() 等时，提供的转换器会在 NewDbModelType 类型的 Firestore 数据和您的自定义类型 NewAppModelType 之间进行转换。
withConverter(converter)		移除当前转换器。

DocumentReference.converter

与此实例关联的 FirestoreDataConverter（如果提供）。

签名：

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

DocumentReference.firestore

文档所在的 Firestore 实例。这对于执行事务非常有用。

签名：

readonly firestore: Firestore;

DocumentReference.id

文档集合中的标识符。

签名：

get id(): string;

DocumentReference.parent

此DocumentReference所属的集合。

签名：

get parent(): CollectionReference<AppModelType, DbModelType>;

文档引用路径

一个字符串，表示参考文档的路径（相对于数据库的根目录）。

签名：

get path(): string;

DocumentReference.type

此 Firestore 引用的类型。

签名：

readonly type = "document";

DocumentReference.withConverter()

将自定义数据转换器应用于此 DocumentReference，这样您就可以将自己的自定义模型对象用于 Firestore。当您使用返回的 DocumentReference 实例调用 setDoc()、getDoc() 等时，提供的转换器将在 NewDbModelType 类型的 Firestore 数据和您的自定义类型 NewAppModelType 之间进行转换。

签名：

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;

参数

参数	类型	说明
converter	FirestoreDataConverter<NewAppModelType, NewDbModelType>	在 Firestore 之间转换对象。

返回：

DocumentReference<NewAppModelType, NewDbModelType>

使用所提供的转换器的 DocumentReference。

DocumentReference.withConverter()

移除当前转换器。

签名：

withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;

参数

参数	类型	说明
converter	null	null 可移除当前转换器。

返回：

DocumentReference<DocumentData、DocumentData>

不使用转换器的 DocumentReference<DocumentData, DocumentData>。