Ein QuerySnapshot
enthält null oder mehr DocumentSnapshot
Objekte, die die Ergebnisse einer Abfrage darstellen. Auf die Dokumente kann als Array über die docs
Eigenschaft zugegriffen oder mit der forEach
Methode aufgezählt werden. Die Anzahl der Dokumente kann über die Eigenschaften empty
und size
bestimmt werden.
Unterschrift:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Eigenschaften
Eigentum | Modifikatoren | Typ | Beschreibung |
---|---|---|---|
Dokumente | Array< QueryDocumentSnapshot <AppModelType, DbModelType>> | Ein Array aller Dokumente im QuerySnapshot . | |
leer | Boolescher Wert | True, wenn im QuerySnapshot keine Dokumente vorhanden sind. | |
Abfrage | Abfrage <AppModelType, DbModelType> | Die Abfrage, für die Sie getDocs() aufgerufen haben, um diesen QuerySnapshot abzurufen. | |
Größe | Nummer | Die Anzahl der Dokumente im QuerySnapshot . |
Methoden
Methode | Modifikatoren | Beschreibung |
---|---|---|
forEach(callback, thisArg) | Listet alle Dokumente im QuerySnapshot auf. |
QuerySnapshot.docs
Ein Array aller Dokumente im QuerySnapshot
.
Unterschrift:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
True, wenn im QuerySnapshot
keine Dokumente vorhanden sind .
Unterschrift:
get empty(): boolean;
QuerySnapshot.query
Die Abfrage, für die Sie getDocs() aufgerufen haben, um diesen QuerySnapshot
abzurufen .
Unterschrift:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.size
Die Anzahl der Dokumente im QuerySnapshot
.
Unterschrift:
get size(): number;
QuerySnapshot.forEach()
Listet alle Dokumente im QuerySnapshot
auf .
Unterschrift:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Ruf zurück | (Ergebnis: QueryDocumentSnapshot <AppModelType, DbModelType>) => void | Ein Rückruf, der mit einem QueryDocumentSnapshot für jedes Dokument im Snapshot aufgerufen werden soll. |
thisArg | Unbekannt | Die this Bindung für den Rückruf. |
Kehrt zurück:
Leere