DocumentReference mengacu ke lokasi dokumen dalam database Firestore dan dapat digunakan untuk menulis, membaca, atau memproses lokasi. Dokumen di lokasi yang dirujuk mungkin ada atau tidak.
Tanda Tangan:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Properti
| Properti | Pengubah | Jenis | Deskripsi |
|---|---|---|---|
| pengonversi | FirestoreDataConverter<AppModelType, DbModelType> | null (kosong) | Jika disediakan, FirestoreDataConverter yang terkait dengan instance ini. |
|
| firestore | Firestore | Instance Firestore tempat dokumen berada. Ini berguna untuk melakukan transaksi, misalnya. | |
| id | string | ID dokumen dalam koleksinya. | |
| parent | CollectionReference<AppModelType, DbModelType> | Koleksi DocumentReference ini. |
|
| path | string | String yang mewakili jalur dokumen yang direferensikan (relatif terhadap root database). | |
| jenis | (tidak dinyatakan) | Jenis referensi Firestore ini. |
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| withConverter(pengonversi) | Menerapkan konverter data kustom ke DocumentReference ini, sehingga Anda dapat menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil setDoc(), getDoc(), dll. dengan instance DocumentReference yang ditampilkan, pengonversi yang disediakan akan mengonversi antara data Firestore jenis NewDbModelType dan jenis kustom Anda NewAppModelType. |
|
| withConverter(pengonversi) | Menghapus pengonversi saat ini. |
DocumentReference.converter
Jika disediakan, FirestoreDataConverter yang terkait dengan instance ini.
Tanda Tangan:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
Instance Firestore tempat dokumen berada. Ini berguna untuk melakukan transaksi, misalnya.
Tanda Tangan:
readonly firestore: Firestore;
DocumentReference.id
ID dokumen dalam koleksinya.
Tanda Tangan:
get id(): string;
DocumentReference.parent
Koleksi DocumentReference ini.
Tanda Tangan:
get parent(): CollectionReference<AppModelType, DbModelType>;
DocumentReference.path
String yang mewakili jalur dokumen yang direferensikan (relatif terhadap root database).
Tanda Tangan:
get path(): string;
DocumentReference.type
Jenis referensi Firestore ini.
Tanda Tangan:
readonly type = "document";
DocumentReference.withConverter()
Menerapkan pengonversi data kustom ke DocumentReference ini, sehingga Anda dapat menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil setDoc(), getDoc(), dll. dengan instance DocumentReference yang ditampilkan, pengonversi yang disediakan akan mengonversi antara data Firestore jenis NewDbModelType dan jenis kustom NewAppModelType.
Tanda Tangan:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| converter | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Mengonversi objek ke dan dari Firestore. |
Hasil:
DocumentReference<NewAppModelType, NewDbModelType>
DocumentReference yang menggunakan konverter yang disediakan.
DocumentReference.withConverter()
Menghapus pengonversi saat ini.
Tanda Tangan:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| converter | null | null menghapus pengonversi saat ini. |
Hasil:
DocumentReference<DocumentData, DocumentData>
DocumentReference<DocumentData, DocumentData> yang tidak menggunakan konverter.