Um QuerySnapshot
contém zero ou mais objetos DocumentSnapshot
que representam os resultados de uma consulta. Os documentos podem ser acessados como um array através da propriedade docs
ou enumerados usando o método forEach
. O número de documentos pode ser determinado através das 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, DbModelType>> | Uma matriz de todos os documentos no QuerySnapshot . | |
vazio | boleano | Verdadeiro se não houver documentos no QuerySnapshot . | |
consulta | Consulta <AppModelType, DbModelType> | A consulta na qual você chamou getDocs() para obter este QuerySnapshot . | |
tamanho | número | O número de documentos no QuerySnapshot . |
Métodos
Método | Modificadores | Descrição |
---|---|---|
forEach(retorno de chamada, thisArg) | Enumera todos os documentos no QuerySnapshot . |
QuerySnapshot.docs
Uma matriz de todos os documentos no QuerySnapshot
.
Assinatura:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
Verdadeiro se não houver documentos no QuerySnapshot
.
Assinatura:
get empty(): boolean;
QuerySnapshot.query
A consulta na qual você chamou getDocs() para obter este QuerySnapshot
.
Assinatura:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.size
O número de documentos no QuerySnapshot
.
Assinatura:
get size(): number;
QuerySnapshot.forEach()
Enumera todos os documentos no QuerySnapshot
.
Assinatura:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
ligar de volta | (resultado: QueryDocumentSnapshot <AppModelType, DbModelType>) => vazio | Um retorno de chamada a ser chamado com um QueryDocumentSnapshot para cada documento no instantâneo. |
esteArg | desconhecido | A ligação this para o retorno de chamada. |
Retorna:
vazio