Ein QueryDocumentSnapshot enthält Daten, die im Rahmen einer Abfrage aus einem Dokument in Ihrer Firestore-Datenbank gelesen wurden. Die Existenz des Dokuments ist garantiert und seine Daten können mit .data() oder .get(<field>) extrahiert werden, um ein bestimmtes Feld zu erhalten.
Ein QueryDocumentSnapshot bietet die gleiche API-Oberfläche wie ein DocumentSnapshot . Da Abfrageergebnisse nur vorhandene Dokumente enthalten, ist die Eigenschaft „ exists “ immer wahr und data() gibt niemals „undefiniert“ zurück.
Unterschrift:
export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>
Erweitert: DocumentSnapshot <AppModelType, DbModelType>
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| Daten(Optionen) | Ruft alle Felder im Dokument als Object ab. Standardmäßig werden serverTimestamp() Werte, die noch nicht auf ihren endgültigen Wert gesetzt wurden, als null zurückgegeben. Sie können dies überschreiben, indem Sie ein Optionsobjekt übergeben. |
QueryDocumentSnapshot.data()
Ruft alle Felder im Dokument als Object .
Standardmäßig werden serverTimestamp() Werte, die noch nicht auf ihren endgültigen Wert gesetzt wurden, als null zurückgegeben . Sie können dies überschreiben, indem Sie ein Optionsobjekt übergeben.
Unterschrift:
/** @override */
data(options?: SnapshotOptions): AppModelType;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Optionen | SnapshotOptions | Ein Optionsobjekt zum Konfigurieren, wie Daten aus dem Snapshot abgerufen werden (z. B. das gewünschte Verhalten für Server-Zeitstempel, die noch nicht auf ihren endgültigen Wert gesetzt wurden). |
Kehrt zurück:
AppModelType
Ein Object , das alle Felder im Dokument enthält.