CollectionReference class

CollectionReference 物件可用於新增文件、取得文件參照及查詢文件 (使用 query())。

簽名：

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

擴充： Query<AppModelType, DBMModelType>

屬性

屬性	修飾符	類型	說明
id		字串	產品素材資源集合的 ID。
parent		DocumentReference<DocumentData、DocumentData>|空值	這是對含有 DocumentReference 的參照 (如果這是子集合)。如果不是子集合，則參照為空值。
路徑		字串	代表參照集合路徑的字串 (相對於資料庫根目錄)。
類型		(未宣告)	這項 Firestore 參考資料的類型。

方法

方法	修飾符	說明
withConverter(converter)		將自訂資料轉換器套用至這個 CollectionReference，您就能透過 Firestore 使用自己的自訂模型物件。當您使用傳回的 CollectionReference 執行個體呼叫 addDoc() 時，提供的轉換工具會在 NewDbModelType 類型的 Firestore 資料和自訂類型 NewAppModelType 之間進行轉換。
withConverter(converter)		移除目前的轉換工具。

CollectionReference.id

集合的 ID。

簽名：

get id(): string;

CollectionReference.parent

這是對含有 DocumentReference 的參照 (如果這是子集合)。如果不是子集合，則參照為空值。

簽名：

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，或從 Firestore 轉換物件。

傳回：

CollectionReference<NewAppModelType、NewDbModelType>

使用提供的轉換器的 CollectionReference。

CollectionReference.withConverter()

移除目前的轉換工具。

簽名：

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

參數

參數	類型	說明
converter	null	null 會移除目前的轉換工具。

傳回：

CollectionReference<DocumentData、DocumentData>

不使用轉換器的 CollectionReference<DocumentData, DocumentData>。