DocumentSnapshot
berisi data yang dibaca dari dokumen di database Firestore Anda. Data dapat diekstraksi dengan .data()
atau .get(<field>)
untuk mendapatkan bidang tertentu.
Untuk DocumentSnapshot
yang menunjuk ke dokumen yang tidak ada, akses data apa pun akan menghasilkan 'tidak terdefinisi'. Anda dapat menggunakan metode exists()
untuk memverifikasi keberadaan dokumen secara eksplisit.
Tanda tangan:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Konstruktor
Konstruktor | Pengubah | Keterangan |
---|---|---|
(konstruktor)() | Membuat instance baru dari kelas DocumentSnapshot |
Properti
Properti | Pengubah | Jenis | Keterangan |
---|---|---|---|
pengenal | rangkaian | Properti DocumentSnapshot yang memberikan ID dokumen. | |
referensi | Referensi Dokumen <AppModelType, DbModelType> | DocumentReference untuk dokumen yang disertakan dalam DocumentSnapshot . |
Metode
metode | Pengubah | Keterangan |
---|---|---|
data() | Mengambil semua bidang dalam dokumen sebagai Object . Mengembalikan undefined jika dokumen tidak ada. | |
ada() | Memberi sinyal apakah dokumen di lokasi snapshot itu ada atau tidak. | |
dapatkan (Jalur Bidang) | Mengambil bidang yang ditentukan oleh fieldPath . Mengembalikan undefined jika dokumen atau bidang tidak ada. |
DocumentSnapshot.(konstruktor)
Membuat instance baru dari kelas DocumentSnapshot
Tanda tangan:
protected constructor();
DokumenSnapshot.id
Properti DocumentSnapshot
yang memberikan ID dokumen.
Tanda tangan:
get id(): string;
DokumenSnapshot.ref
DocumentReference
untuk dokumen yang disertakan dalam DocumentSnapshot
.
Tanda tangan:
get ref(): DocumentReference<AppModelType, DbModelType>;
DokumenSnapshot.data()
Mengambil semua bidang dalam dokumen sebagai Object
. Mengembalikan undefined
jika dokumen tidak ada.
Tanda tangan:
data(): AppModelType | undefined;
Pengembalian:
Tipe Model Aplikasi | belum diartikan
Object
yang berisi semua bidang dalam dokumen atau undefined
jika dokumen tidak ada.
DokumenSnapshot.ada()
Memberi sinyal apakah dokumen di lokasi snapshot itu ada atau tidak.
Tanda tangan:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Pengembalian:
ini adalah QueryDocumentSnapshot <AppModelType, DbModelType>
benar jika dokumen itu ada.
DokumenSnapshot.get()
Mengambil bidang yang ditentukan oleh fieldPath
. Mengembalikan undefined
jika dokumen atau bidang tidak ada.
Tanda tangan:
get(fieldPath: string | FieldPath): any;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
jalur bidang | tali | Jalur Lapangan | Jalur (misalnya 'foo' atau 'foo.bar') ke bidang tertentu. |
Pengembalian:
setiap
Data di lokasi bidang yang ditentukan atau tidak ditentukan jika bidang tersebut tidak ada dalam dokumen.