QuerySnapshot class

Un 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 mediante las propiedades empty y size .

Firma:

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

Propiedades

Propiedad Modificadores Tipo Descripción
documentos Matriz < QueryDocumentSnapshot <AppModelType, DbModelType>> Una matriz de todos los documentos en QuerySnapshot .
vacío booleano Verdadero si no hay documentos en QuerySnapshot .
metadatos InstantáneaMetadatos Metadatos sobre esta instantánea, sobre su fuente y si tiene modificaciones locales.
consulta Consulta <AppModelType, DbModelType> La consulta a la que llamó get o onSnapshot para obtener este QuerySnapshot .
tamaño número El número de documentos en QuerySnapshot .

Métodos

Método Modificadores Descripción
docCambios(opciones) Devuelve una serie de cambios en los documentos desde la última instantánea. Si esta es la primera instantánea, todos los documentos estarán en la lista como cambios "agregados".
paraCada(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.vacío

Verdadero si no hay documentos en QuerySnapshot .

Firma:

get empty(): boolean;

QuerySnapshot.metadatos

Metadatos sobre esta instantánea, sobre su fuente y si tiene modificaciones locales.

Firma:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

La consulta a la que llamó get o onSnapshot para obtener este QuerySnapshot .

Firma:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.tamaño

La cantidad de documentos en QuerySnapshot .

Firma:

get size(): number;

QuerySnapshot.docCambios()

Devuelve una serie de cambios en los documentos desde la última instantánea. Si esta es la primera instantánea, todos los documentos estarán en la lista como cambios "agregados".

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones InstantáneaEscucharOpciones SnapshotListenOptions que controlan si los cambios de solo metadatos (es decir, solo se modifica DocumentSnapshot.metadata ) deben activar eventos de instantánea.

Devoluciones:

Matriz< Cambiar documento <AppModelType, DbModelType>>

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 un QueryDocumentSnapshot para cada documento en la instantánea.
esteArg desconocido El enlace this para la devolución de llamada.

Devoluciones:

vacío