Query class

Eine Query bezieht sich auf eine Abfrage, die Sie lesen oder anhören können. Sie können auch verfeinerte Query erstellen, indem Sie Filter und Sortierungen hinzufügen.

Unterschrift:

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

Konstrukteure

Konstrukteur Modifikatoren Beschreibung
(Konstrukteur)() Konstruiert eine neue Instanz der Query -Klasse

Eigenschaften

Eigentum Modifikatoren Typ Beschreibung
Konverter FirestoreDataConverter <AppModelType, DbModelType> | Null Falls angegeben, der dieser Instanz zugeordnete FirestoreDataConverter .
Feuerladen Feuerladen Die Firestore Instanz für die Firestore-Datenbank (nützlich zum Durchführen von Transaktionen usw.).
Typ 'Abfrage' | 'Sammlung' Der Typ dieser Firestore-Referenz.

Methoden

Methode Modifikatoren Beschreibung
withConverter(Konverter) Entfernt den aktuellen Konverter.
withConverter(Konverter) Wendet einen benutzerdefinierten Datenkonverter auf diese Abfrage an, sodass Sie Ihre eigenen benutzerdefinierten Modellobjekte mit Firestore verwenden können. Wenn Sie getDocs() mit der zurückgegebenen Abfrage aufrufen, konvertiert der bereitgestellte Konverter zwischen Firestore-Daten vom Typ NewDbModelType und Ihrem benutzerdefinierten Typ NewAppModelType .

Abfrage.(Konstruktor)

Konstruiert eine neue Instanz der Query -Klasse

Unterschrift:

protected constructor();

Abfragekonverter

Falls angegeben, der dieser Instanz zugeordnete FirestoreDataConverter .

Unterschrift:

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

Query.firestore

Die Firestore Instanz für die Firestore-Datenbank (nützlich zum Durchführen von Transaktionen usw.).

Unterschrift:

readonly firestore: Firestore;

Abfragetyp

Der Typ dieser Firestore-Referenz.

Unterschrift:

readonly type: 'query' | 'collection';

Query.withConverter()

Entfernt den aktuellen Konverter.

Unterschrift:

withConverter(converter: null): Query<DocumentData, DocumentData>;

Parameter

Parameter Typ Beschreibung
Konverter Null null entfernt den aktuellen Konverter.

Kehrt zurück:

Abfrage < Dokumentdaten , Dokumentdaten >

Eine Query<DocumentData, DocumentData> , die keinen Konverter verwendet.

Query.withConverter()

Wendet einen benutzerdefinierten Datenkonverter auf diese Abfrage an, sodass Sie Ihre eigenen benutzerdefinierten Modellobjekte mit Firestore verwenden können. Wenn Sie getDocs() mit der zurückgegebenen Abfrage aufrufen, konvertiert der bereitgestellte Konverter zwischen Firestore-Daten vom Typ NewDbModelType und Ihrem benutzerdefinierten Typ NewAppModelType .

Unterschrift:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;

Parameter

Parameter Typ Beschreibung
Konverter FirestoreDataConverter <NewAppModelType, NewDbModelType> Konvertiert Objekte in und aus Firestore.

Kehrt zurück:

Abfrage <NewAppModelType, NewDbModelType>

Eine Query , die den bereitgestellten Konverter verwendet.