DocumentReference
是指 Firestore 資料庫中的文件位置,可用於寫入、讀取或偵聽該位置。引用位置處的文件可能存在,也可能不存在。
簽名:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
特性
財產 | 修飾符 | 類型 | 描述 |
---|---|---|---|
轉換器 | Firestore資料轉換器<AppModelType,DbModelType> |無效的 | 如果提供,則為與此執行個體關聯的FirestoreDataConverter 。 | |
火庫 | 火庫 | 文件所在的Firestore實例。例如,這對於執行交易很有用。 | |
ID | 細繩 | 文檔在其集合中的標識符。 | |
家長 | 收藏參考<應用程式模型類型,Db模型類型> | 此DocumentReference 所屬的集合。 | |
小路 | 細繩 | 表示引用文件的路徑(相對於資料庫的根目錄)的字串。 | |
類型 | (未聲明) | 此 Firestore 引用的類型。 |
方法
方法 | 修飾符 | 描述 |
---|---|---|
與轉換器(轉換器) | 對此DocumentReference 套用自訂資料轉換器,讓您可以將自己的自訂模型物件與 Firestore 結合使用。當您呼叫setDoc()時,取得文檔()等等,使用傳回的DocumentReference 實例,提供的轉換器將在NewDbModelType 類型的 Firestore 資料和您的自訂類型NewAppModelType 之間進行轉換。 | |
與轉換器(轉換器) | 移除電流轉換器。 |
文件參考轉換器
如果提供,則為與此執行個體關聯的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>;
參數
範圍 | 類型 | 描述 |
---|---|---|
轉換器 | Firestore資料轉換器<新應用程式模型類型、新資料庫模型類型> | 將物件與 Firestore 相互轉換。 |
返回:
文件參考<新應用程式模型類型、新資料庫模型類型>
使用提供的轉換器的DocumentReference
。
DocumentReference.withConverter()
移除電流轉換器。
簽名:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
參數
範圍 | 類型 | 描述 |
---|---|---|
轉換器 | 無效的 | null 刪除目前轉換器。 |
返回:
不使用轉換器的DocumentReference<DocumentData, DocumentData>
。