QuerySnapshot class

Un QuerySnapshot contient zéro ou plusieurs objets DocumentSnapshot représentant les résultats d'une requête. Les documents sont accessibles sous forme de tableau via la propriété docs ou énumérés à l'aide de la méthode forEach . Le nombre de documents peut être déterminé via les propriétés empty et size .

Signature:

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

Propriétés

Méthodes

QuerySnapshot.docs

Un tableau de tous les documents du QuerySnapshot .

Signature:

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

QuerySnapshot.empty

Vrai s'il n'y a aucun document dans le QuerySnapshot .

Signature:

get empty(): boolean;

QuerySnapshot.metadonnées

Métadonnées sur cet instantané, concernant sa source et s'il comporte des modifications locales.

Signature:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

La requête sur laquelle vous avez appelé get ou onSnapshot afin d'obtenir ce QuerySnapshot .

Signature:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

Le nombre de documents dans le QuerySnapshot .

Signature:

get size(): number;

QuerySnapshot.docChanges()

Renvoie un tableau des modifications apportées aux documents depuis le dernier instantané. S'il s'agit du premier instantané, tous les documents seront dans la liste en tant que modifications « ajoutées ».

Signature:

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

Paramètres

Retour:

Tableau< DocumentChange <AppModelType, DbModelType>>

QuerySnapshot.forEach()

Énumère tous les documents dans QuerySnapshot .

Signature:

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

Paramètres

Retour:

vide