QuerySnapshot class

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

Methoden

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.metadata

Metadaten zu diesem Snapshot, bezüglich seiner Quelle und ob er lokale Änderungen aufweist.

Unterschrift:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

Die Abfrage, für die Sie get oder onSnapshot 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.docChanges()

Gibt ein Array der Dokumentänderungen seit dem letzten Snapshot zurück. Wenn es sich um den ersten Snapshot handelt, werden alle Dokumente als „hinzugefügte“ Änderungen in der Liste angezeigt.

Unterschrift:

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

Parameter

Kehrt zurück:

Array< DocumentChange <AppModelType, DbModelType>>

QuerySnapshot.forEach()

Listet alle Dokumente im QuerySnapshot auf .

Unterschrift:

forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;

Parameter

Kehrt zurück:

Leere