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 | Deskripsi |
|---|---|---|
| (konstruktor)() | Membuat instance baru dari class Query |
Properti
| Properti | Pengubah | Jenis | Deskripsi |
|---|---|---|---|
| pengonversi | FirestoreDataConverter<AppModelType, DbModelType> | null (kosong) | Jika disediakan, FirestoreDataConverter yang terkait dengan instance ini. |
|
| firestore | Firestore | Instance Firestore untuk database Firestore (berguna untuk melakukan transaksi, dll.). |
|
| jenis | 'kueri' | 'koleksi' | Jenis referensi Firestore ini. |
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| withConverter(pengonversi) | Menghapus pengonversi saat ini. | |
| withConverter(pengonversi) | Menerapkan konverter data kustom ke kueri ini, sehingga Anda dapat menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil getDocs() dengan kueri yang ditampilkan, pengonversi yang disediakan akan mengonversi antara data Firestore jenis NewDbModelType dan jenis kustom NewAppModelType. |
Query.(konstruktor)
Membuat instance baru dari class Query
Tanda Tangan:
protected constructor();
Query.converter
Jika disediakan, FirestoreDataConverter yang terkait dengan instance ini.
Tanda Tangan:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Query.firestore
Instance Firestore untuk database Firestore (berguna untuk melakukan transaksi, dll.).
Tanda Tangan:
readonly firestore: Firestore;
Query.type
Jenis referensi Firestore ini.
Tanda Tangan:
readonly type: 'query' | 'collection';
Query.withConverter()
Menghapus pengonversi saat ini.
Tanda Tangan:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| converter | null | null menghapus pengonversi saat ini. |
Hasil:
Kueri<DocumentData, DocumentData>
Query<DocumentData, DocumentData> yang tidak menggunakan konverter.
Query.withConverter()
Menerapkan konverter data kustom ke kueri ini, sehingga Anda dapat menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil getDocs() dengan kueri yang ditampilkan, pengonversi yang disediakan akan mengonversi antara data Firestore jenis NewDbModelType dan jenis kustom NewAppModelType.
Tanda Tangan:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| converter | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Mengonversi objek ke dan dari Firestore. |
Hasil:
Kueri<NewAppModelType, NewDbModelType>
Query yang menggunakan konverter yang disediakan.