DocumentSnapshot berisi data yang dibaca dari dokumen dalam database Firestore Anda. Data dapat diekstrak dengan .data() atau .get(<field>) untuk mendapatkan kolom tertentu.
Untuk DocumentSnapshot yang mengarah ke dokumen yang tidak ada, akses data apa pun akan menampilkan 'undefined'. 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 | Deskripsi |
|---|---|---|
| (konstruktor)() | Membuat instance baru dari class DocumentSnapshot |
Properti
| Properti | Pengubah | Jenis | Deskripsi |
|---|---|---|---|
| id | string | Properti DocumentSnapshot yang memberikan ID dokumen. |
|
| referensi | DocumentReference<AppModelType, DbModelType> | DocumentReference untuk dokumen yang disertakan dalam DocumentSnapshot. |
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| data() | Mengambil semua kolom dalam dokumen sebagai Object. Menampilkan undefined jika dokumen tidak ada. |
|
| exists() | Memberikan sinyal apakah dokumen di lokasi snapshot ada atau tidak. | |
| get(fieldPath) | Mengambil kolom yang ditentukan oleh fieldPath. Menampilkan undefined jika dokumen atau kolom tidak ada. |
DocumentSnapshot.(konstruktor)
Membuat instance baru dari class DocumentSnapshot
Tanda Tangan:
protected constructor();
DocumentSnapshot.id
Properti DocumentSnapshot yang memberikan ID dokumen.
Tanda Tangan:
get id(): string;
DocumentSnapshot.ref
DocumentReference untuk dokumen yang disertakan dalam DocumentSnapshot.
Tanda Tangan:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Mengambil semua kolom dalam dokumen sebagai Object. Menampilkan undefined jika dokumen tidak ada.
Tanda Tangan:
data(): AppModelType | undefined;
Hasil:
AppModelType | tidak ditentukan
Object yang berisi semua kolom dalam dokumen atau undefined jika dokumen tidak ada.
DocumentSnapshot.exists()
Memberikan sinyal apakah dokumen di lokasi snapshot ada atau tidak.
Tanda Tangan:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Hasil:
ini adalah QueryDocumentSnapshot<AppModelType, DbModelType>
benar (true) jika dokumen ada.
DocumentSnapshot.get()
Mengambil kolom yang ditentukan oleh fieldPath. Menampilkan undefined jika dokumen atau kolom tidak ada.
Tanda Tangan:
get(fieldPath: string | FieldPath): any;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| fieldPath | rangkaian | FieldPath | Jalur (misalnya 'foo' atau 'foo.bar') ke kolom tertentu. |
Hasil:
apa pun
Data di lokasi kolom yang ditentukan atau tidak ditentukan jika tidak ada kolom tersebut dalam dokumen.