Query mengacu pada kueri yang dapat Anda baca atau dengarkan. Anda juga dapat membuat objek Query yang disempurnakan dengan menambahkan filter dan pengurutan.
Tanda tangan:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Konstruktor
| Konstruktor | Pengubah | Keterangan |
|---|---|---|
| (konstruktor)() | Membangun instance baru dari kelas Query |
Properti
| Properti | Pengubah | Jenis | Keterangan |
|---|---|---|---|
| konverter | Konverter Data Firestore <AppModelType, DbModelType> | batal | Jika disediakan, FirestoreDataConverter terkait dengan instance ini. | |
| toko api | toko pemadam kebakaran | Instance Firestore untuk database Firestore (berguna untuk melakukan transaksi, dll.). | |
| jenis | 'permintaan' | 'koleksi' | Jenis referensi Firestore ini. |
Metode
| metode | Pengubah | Keterangan |
|---|---|---|
| denganConverter(konverter) | Menghapus konverter saat ini. | |
| denganConverter(konverter) | Menerapkan konverter data khusus ke kueri ini, memungkinkan Anda menggunakan objek model khusus Anda sendiri dengan Firestore. Saat Anda memanggil getDocs() dengan kueri yang dikembalikan, konverter yang disediakan akan mengonversi antara data Firestore bertipe NewDbModelType dan tipe kustom Anda NewAppModelType . |
Kueri.(konstruktor)
Membangun instance baru dari kelas Query
Tanda tangan:
protected constructor();
Kueri.konverter
Jika disediakan, FirestoreDataConverter terkait dengan instance ini.
Tanda tangan:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Kueri.firestore
Instance Firestore untuk database Firestore (berguna untuk melakukan transaksi, dll.).
Tanda tangan:
readonly firestore: Firestore;
Kueri.tipe
Jenis referensi Firestore ini.
Tanda tangan:
readonly type: 'query' | 'collection';
Kueri.denganConverter()
Menghapus konverter saat ini.
Tanda tangan:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| konverter | batal | null menghapus konverter saat ini. |
Pengembalian:
Pertanyaan < Data Dokumen , Data Dokumen >
Query<DocumentData, DocumentData> yang tidak menggunakan konverter.
Kueri.denganConverter()
Menerapkan konverter data khusus ke kueri ini, memungkinkan Anda menggunakan objek model khusus Anda sendiri dengan Firestore. Saat Anda memanggil getDocs() dengan kueri yang dikembalikan, konverter yang disediakan akan mengonversi antara data Firestore bertipe NewDbModelType dan tipe kustom Anda NewAppModelType .
Tanda tangan:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| konverter | Konverter Data Firestore <JenisAppModelBaru,JenisDbModelBaru> | Mengonversi objek ke dan dari Firestore. |
Pengembalian:
Pertanyaan <JenisAppModelBaru,JenisDbModelBaru>
Query yang menggunakan konverter yang disediakan.