Una QuerySnapshot contiene cero o más objetos DocumentSnapshot que representan los resultados de una consulta. Se puede acceder a los documentos como una matriz a través de la propiedad docs o enumerarlos usando el método forEach . El número de documentos se puede determinar a través de las propiedades empty y size .
Firma:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Propiedades
| Propiedad | modificadores | Tipo | Descripción |
|---|---|---|---|
| documentos | Array< QueryDocumentSnapshot <Tipo de modelo de aplicación, Tipo de modelo de base de datos>> | Una matriz de todos los documentos en QuerySnapshot . | |
| vacío | booleano | True si no hay documentos en QuerySnapshot . | |
| consulta | Consulta <Tipo de modelo de aplicación, Tipo de modelo de base de datos> | La consulta en la que llamó a getDocs() para obtener esta QuerySnapshot . | |
| tamaño | número | El número de documentos en QuerySnapshot . |
Métodos
| Método | modificadores | Descripción |
|---|---|---|
| forEach(devolución de llamada, thisArg) | Enumera todos los documentos en QuerySnapshot . |
QuerySnapshot.docs
Una matriz de todos los documentos en QuerySnapshot .
Firma:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
True si no hay documentos en QuerySnapshot .
Firma:
get empty(): boolean;
QuerySnapshot.query
La consulta en la que llamó a getDocs() para obtener esta QuerySnapshot .
Firma:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.size
El número de documentos en QuerySnapshot .
Firma:
get size(): number;
QuerySnapshot.forEach()
Enumera todos los documentos en QuerySnapshot .
Firma:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| llamar de vuelta | (resultado: QueryDocumentSnapshot <AppModelType, DbModelType>) => vacío | Una devolución de llamada que se llamará con QueryDocumentSnapshot para cada documento en la instantánea. |
| esteArg | desconocido | El enlace this para la devolución de llamada. |
Devoluciones:
vacío