QuerySnapshot class

QuerySnapshot berisi nol objek DocumentSnapshot atau lebih yang mewakili hasil kueri. Dokumen dapat diakses sebagai array melalui properti docs atau dienumerasi menggunakan metode forEach. Jumlah dokumen dapat ditentukan melalui properti empty dan size.

Tanda Tangan:

export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

Properti

Properti Pengubah Jenis Deskripsi
dokumen Array<QueryDocumentSnapshot<AppModelType, DbModelType>> Array semua dokumen dalam QuerySnapshot.
kosong boolean Benar jika tidak ada dokumen di QuerySnapshot.
metadata SnapshotMetadata Metadata tentang snapshot ini, terkait sumbernya dan apakah snapshot memiliki modifikasi lokal.
query Kueri<AppModelType, DbModelType> Kueri yang Anda gunakan untuk memanggil get atau onSnapshot untuk mendapatkan QuerySnapshot ini.
size angka Jumlah dokumen di QuerySnapshot.

Metode

Metode Pengubah Deskripsi
docChanges(opsi) Menampilkan array perubahan dokumen sejak snapshot terakhir. Jika ini adalah snapshot pertama, semua dokumen akan berada dalam daftar sebagai 'ditambahkan' perubahan.
forSetiap(callback, thisArg) Menghitung semua dokumen di QuerySnapshot.

QuerySnapshot.docs

Array semua dokumen dalam QuerySnapshot.

Tanda Tangan:

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

QuerySnapshot.kosong

Benar jika tidak ada dokumen di QuerySnapshot.

Tanda Tangan:

get empty(): boolean;

QuerySnapshot.metadata

Metadata tentang snapshot ini, terkait sumbernya dan apakah snapshot memiliki modifikasi lokal.

Tanda Tangan:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

Kueri di mana Anda memanggil get atau onSnapshot untuk mendapatkan QuerySnapshot ini.

Tanda Tangan:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

Jumlah dokumen di QuerySnapshot.

Tanda Tangan:

get size(): number;

QuerySnapshot.docChanges()

Menampilkan array perubahan dokumen sejak snapshot terakhir. Jika ini adalah snapshot pertama, semua dokumen akan berada dalam daftar sebagai 'ditambahkan' perubahan.

Tanda Tangan:

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

Parameter

Parameter Jenis Deskripsi
opsi SnapshotListenOptions SnapshotListenOptions yang mengontrol apakah perubahan khusus metadata (yaitu hanya DocumentSnapshot.metadata yang diubah) akan memicu peristiwa snapshot.

Hasil:

Array<DocumentChange<AppModelType, DbModelType>>

QuerySnapshot.forSetiap()

Menghitung semua dokumen di QuerySnapshot.

Tanda Tangan:

forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;

Parameter

Parameter Jenis Deskripsi
callback (hasil: QueryDocumentSnapshot<AppModelType, DbModelType>) => kosong Callback yang akan dipanggil dengan QueryDocumentSnapshot untuk setiap dokumen dalam snapshot.
ThisArg tidak diketahui Binding this untuk callback.

Hasil:

void