DocumentSnapshot class

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.
metadata SnapshotMetadata Metadata tentang DocumentSnapshot, termasuk informasi tentang sumbernya dan modifikasi lokalnya.
referensi DocumentReference<AppModelType, DbModelType> DocumentReference untuk dokumen yang disertakan dalam DocumentSnapshot.

Metode

Metode Pengubah Deskripsi
data(opsi) Mengambil semua kolom dalam dokumen sebagai Object. Menampilkan undefined jika dokumen tidak ada.Secara default, nilai serverTimestamp() yang belum ditetapkan ke nilai akhirnya akan ditampilkan sebagai null. Anda dapat menggantinya dengan meneruskan objek opsi.
exists() Menampilkan apakah data ada atau tidak. True jika dokumen ada.
get(fieldPath, options) Mengambil kolom yang ditentukan oleh fieldPath. Menampilkan undefined jika dokumen atau kolom tidak ada.Secara default, serverTimestamp() yang belum ditetapkan ke nilai akhirnya akan ditampilkan sebagai null. Anda dapat menggantinya dengan meneruskan objek opsi.

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.metadata

Metadata tentang DocumentSnapshot, termasuk informasi tentang sumbernya dan modifikasi lokalnya.

Tanda Tangan:

readonly metadata: SnapshotMetadata;

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.

Secara default, nilai serverTimestamp() yang belum ditetapkan ke nilai akhirnya akan ditampilkan sebagai null. Anda dapat menggantinya dengan meneruskan objek opsi.

Tanda Tangan:

data(options?: SnapshotOptions): AppModelType | undefined;

Parameter

Parameter Jenis Deskripsi
opsi SnapshotOptions Objek opsi untuk mengonfigurasi cara data diambil dari snapshot (misalnya, perilaku yang diinginkan untuk stempel waktu server yang belum ditetapkan ke nilai akhirnya).

Hasil:

AppModelType | tidak ditentukan

Object yang berisi semua kolom dalam dokumen atau undefined jika dokumen tidak ada.

DocumentSnapshot.exists()

Menampilkan apakah data ada atau tidak. True jika dokumen ada.

Tanda Tangan:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

Hasil:

ini adalah QueryDocumentSnapshot<AppModelType, DbModelType>

DocumentSnapshot.get()

Mengambil kolom yang ditentukan oleh fieldPath. Menampilkan undefined jika dokumen atau kolom tidak ada.

Secara default, serverTimestamp() yang belum ditetapkan ke nilai akhirnya akan ditampilkan sebagai null. Anda dapat menggantinya dengan meneruskan objek opsi.

Tanda Tangan:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

Parameter

Parameter Jenis Deskripsi
fieldPath rangkaian | FieldPath Jalur (misalnya 'foo' atau 'foo.bar') ke kolom tertentu.
opsi SnapshotOptions Objek opsi untuk mengonfigurasi cara kolom diambil dari snapshot (misalnya, perilaku yang diinginkan untuk stempel waktu server yang belum ditetapkan ke nilai akhirnya).

Hasil:

apa pun

Data di lokasi kolom yang ditentukan atau tidak ditentukan jika tidak ada kolom tersebut dalam dokumen.