QuerySnapshot class

Um QuerySnapshot contém zero ou mais objetos DocumentSnapshot que representam os resultados de uma consulta. Eles podem ser acessados como uma matriz usando a propriedade docs ou enumerados usando o método forEach. O número de documentos pode ser determinado pelas propriedades empty e size.

Assinatura:

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

Propriedades

Propriedade	Modificadores	Tipo	Descrição
documentos		Matriz<QueryDocumentSnapshot<AppModelType, DBMModelType>>	Uma matriz de todos os documentos em QuerySnapshot.
vazio		booleano	Verdadeiro se não houver documentos no QuerySnapshot.
query		Consulta<AppModelType, DBMModelType>	A consulta em que você chamou getDocs() para receber esse QuerySnapshot.
size		number	O número de documentos em QuerySnapshot.

Métodos

Método	Modificadores	Descrição
forevery(callback, thisArg) (link em inglês)		Enumera todos os documentos no QuerySnapshot.

QuerySnapshot.docs

Uma matriz de todos os documentos em QuerySnapshot.

Assinatura:

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

QuerySnapshot.empty

Verdadeiro se não houver documentos na QuerySnapshot.

Assinatura:

get empty(): boolean;

QuerySnapshot.query

A consulta em que você chamou getDocs() para receber esse QuerySnapshot.

Assinatura:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

O número de documentos em QuerySnapshot.

Assinatura:

get size(): number;

QuerySnapshot.forCada()

Enumera todos os documentos em QuerySnapshot.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
callback	(resultado: QueryDocumentSnapshot<AppModelType, DBMModelType>) => anular	Um callback a ser chamado com um QueryDocumentSnapshot para cada documento no snapshot.
esteArg	desconhecido	A vinculação this do callback.

Retorna:

void