QuerySnapshot berisi nol atau lebih objek DocumentSnapshot yang mewakili hasil kueri. Dokumen dapat diakses sebagai array melalui properti docs atau dihitung 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 | Keterangan |
|---|---|---|---|
| dokumen | Array< QueryDocumentSnapshot <AppModelType, DbModelType>> | Array semua dokumen di QuerySnapshot . | |
| kosong | boolean | Benar jika tidak ada dokumen di QuerySnapshot . | |
| metadata | Metadata Cuplikan | Metadata tentang snapshot ini, mengenai sumbernya dan apakah ada modifikasi lokal. | |
| pertanyaan | Pertanyaan <AppModelType, DbModelType> | Kueri yang Anda panggil get atau onSnapshot untuk mendapatkan QuerySnapshot ini. | |
| ukuran | nomor | Jumlah dokumen di QuerySnapshot . |
Metode
| metode | Pengubah | Keterangan |
|---|---|---|
| perubahan dokumen (opsi) | Mengembalikan array perubahan dokumen sejak snapshot terakhir. Jika ini adalah snapshot pertama, semua dokumen akan ada dalam daftar sebagai perubahan yang 'ditambahkan'. | |
| forEach(panggilan balik, thisArg) | Menghitung semua dokumen di QuerySnapshot . |
QuerySnapshot.docs
Array dari semua dokumen di 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, mengenai sumbernya dan apakah ada modifikasi lokal.
Tanda tangan:
readonly metadata: SnapshotMetadata;
QuerySnapshot.query
Kueri yang Anda panggil get atau onSnapshot untuk mendapatkan QuerySnapshot ini .
Tanda tangan:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.ukuran
Jumlah dokumen di QuerySnapshot .
Tanda tangan:
get size(): number;
KueriSnapshot.docChanges()
Mengembalikan array perubahan dokumen sejak snapshot terakhir. Jika ini adalah snapshot pertama, semua dokumen akan ada dalam daftar sebagai perubahan yang 'ditambahkan'.
Tanda tangan:
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| pilihan | Opsi SnapshotListen | SnapshotListenOptions yang mengontrol apakah perubahan hanya metadata (yaitu hanya DocumentSnapshot.metadata yang diubah) harus memicu peristiwa snapshot. |
Pengembalian:
Array< Perubahan Dokumen <AppModelType, DbModelType>>
QuerySnapshot.forEach()
Menghitung semua dokumen di QuerySnapshot .
Tanda tangan:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| panggilan balik | (hasil: QueryDocumentSnapshot <AppModelType, DbModelType>) => batal | Panggilan balik yang akan dipanggil dengan QueryDocumentSnapshot untuk setiap dokumen di snapshot. |
| iniArg | tidak dikenal | this mengikat untuk panggilan balik. |
Pengembalian:
ruang kosong