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. | |
| metadata | Metadata Cuplikan | Metadata tentang DocumentSnapshot , termasuk informasi tentang sumbernya dan modifikasi lokalnya. | |
| referensi | Referensi Dokumen <AppModelType, DbModelType> | DocumentReference untuk dokumen yang disertakan dalam DocumentSnapshot . |
Metode
| metode | Pengubah | Keterangan |
|---|---|---|
| data(pilihan) | Mengambil semua bidang dalam dokumen sebagai Object . Mengembalikan undefined jika dokumen tidak ada. Secara default, nilai serverTimestamp() yang belum disetel ke nilai akhirnya akan dikembalikan sebagai null . Anda dapat menimpanya dengan meneruskan objek opsi. | |
| ada() | Mengembalikan apakah datanya ada atau tidak. Benar jika dokumennya ada. | |
| dapatkan(fieldPath, opsi) | Mengambil bidang yang ditentukan oleh fieldPath . Mengembalikan undefined jika dokumen atau bidang tidak ada. Secara default, serverTimestamp() yang belum disetel ke nilai akhirnya akan dikembalikan sebagai null . Anda dapat menimpanya dengan meneruskan objek opsi. |
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.metadata
Metadata tentang DocumentSnapshot , termasuk informasi tentang sumbernya dan modifikasi lokalnya.
Tanda tangan:
readonly metadata: SnapshotMetadata;
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.
Secara default, nilai serverTimestamp() yang belum disetel ke nilai akhirnya akan dikembalikan sebagai null . Anda dapat menimpanya dengan meneruskan objek opsi.
Tanda tangan:
data(options?: SnapshotOptions): AppModelType | undefined;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| pilihan | Opsi Snapshot | Objek opsi untuk mengonfigurasi cara data diambil dari snapshot (misalnya perilaku yang diinginkan untuk stempel waktu server yang belum disetel ke nilai akhirnya). |
Pengembalian:
Tipe Model Aplikasi | belum diartikan
Object yang berisi semua bidang dalam dokumen atau undefined jika dokumen tidak ada.
DokumenSnapshot.ada()
Mengembalikan apakah datanya ada atau tidak. Benar jika dokumennya ada.
Tanda tangan:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Pengembalian:
ini adalah QueryDocumentSnapshot <AppModelType, DbModelType>
DokumenSnapshot.get()
Mengambil bidang yang ditentukan oleh fieldPath . Mengembalikan undefined jika dokumen atau bidang tidak ada.
Secara default, serverTimestamp() yang belum disetel ke nilai akhirnya akan dikembalikan sebagai null . Anda dapat menimpanya dengan meneruskan objek opsi.
Tanda tangan:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| jalur bidang | tali | Jalur Lapangan | Jalur (misalnya 'foo' atau 'foo.bar') ke bidang tertentu. |
| pilihan | Opsi Snapshot | Objek opsi untuk mengonfigurasi cara bidang diambil dari snapshot (misalnya perilaku yang diinginkan untuk stempel waktu server yang belum disetel ke nilai akhirnya). |
Pengembalian:
setiap
Data di lokasi bidang yang ditentukan atau tidak ditentukan jika bidang tersebut tidak ada dalam dokumen.