DocumentReference class

DocumentReference是指 Firestore 資料庫中的文件位置，可用於寫入、讀取或偵聽該位置。引用位置處的文件可能存在，也可能不存在。

簽名：

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

特性

方法

文件參考轉換器

如果提供，則為與此執行個體關聯的FirestoreDataConverter 。

簽名：

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

文檔Reference.firestore

文件所在的Firestore實例。例如，這對於執行交易很有用。

簽名：

readonly firestore: Firestore;

文檔參考.id

文檔在其集合中的標識符。

簽名：

get id(): string;

文件參考.parent

此DocumentReference所屬的集合。

簽名：

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

文件參考.path

表示引用文件的路徑（相對於資料庫的根目錄）的字串。

簽名：

get path(): string;

文件參考.type

此 Firestore 引用的類型。

簽名：

readonly type = "document";

DocumentReference.withConverter()

將自訂資料轉換器套用至此DocumentReference ，讓您可以將自己的自訂模型物件與 Firestore 結合使用。當您呼叫setDoc()時,取得文檔()等等，使用傳回的DocumentReference實例，提供的轉換器將在NewDbModelType類型的 Firestore 資料和您的自訂類型NewAppModelType之間進行轉換。

簽名：

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

參數

返回：

文件參考<新應用程式模型類型、新資料庫模型類型>

使用提供的轉換器的DocumentReference 。

DocumentReference.withConverter()

移除電流轉換器。

簽名：

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

參數

返回：

文件參考<文檔數據,文檔數據>

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