CollectionReference class

CollectionReference 对象可用于添加文档、获取文档引用和查询文档（使用 query()）。

签名：

export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> 

扩展： Query<AppModelType, DbModelType>

属性

属性	修饰符	类型	说明
id		字符串	集合的标识符。
parent		DocumentReference<DocumentData、DocumentData>|null	对所含 DocumentReference 的引用（如果这是一个子集合）。如果不是子集合，则引用为 null。
path		字符串	一个字符串，表示所引用集合的路径（相对于数据库的根目录）。
type		（未声明）	此 Firestore 引用的类型。

方法

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

CollectionReference.id

集合的标识符。

签名：

get id(): string;

CollectionReference.parent

对所含 DocumentReference 的引用（如果这是一个子集合）。如果不是子集合，则引用为 null。

签名：

get parent(): DocumentReference<DocumentData, DocumentData> | null;

CollectionReference.path

一个字符串，表示所引用集合的路径（相对于数据库的根目录）。

签名：

get path(): string;

CollectionReference.type

此 Firestore 引用的类型。

签名：

readonly type = "collection";

CollectionReference.withConverter()

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

签名：

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

参数

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

返回：

CollectionReference<NewAppModelType, NewDbModelType>

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

CollectionReference.withConverter()

移除当前转换器。

签名：

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

参数

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

返回：

CollectionReference<DocumentData、DocumentData>

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