QuerySnapshot class

Una QuerySnapshot contiene cero o más objetos DocumentSnapshot que representan los resultados de una consulta. Se puede acceder a los documentos como un array a través de la propiedad docs o se pueden enumerar con el método forEach. La cantidad 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 Teclas modificadoras Tipo Descripción
documentos Arreglo<QueryDocumentSnapshot<AppModelType, DrModelType>> Un array de todos los documentos en QuerySnapshot.
vacío booleano Es verdadero si no hay documentos en QuerySnapshot.
metadata SnapshotMetadata Metadatos sobre esta instantánea, en relación con su fuente y si tiene modificaciones locales.
query Consulta<AppModelType, DrModelType> La consulta en la que llamaste a get o onSnapshot para obtener este QuerySnapshot.
size número La cantidad de documentos en el QuerySnapshot.

Métodos

Método Teclas modificadoras Descripción
docChanges(opciones) Muestra un array de los cambios en los documentos desde la última instantánea. Si esta es la primera instantánea, todos los documentos aparecerán en la lista como “agregados”. cambios.
forEach(devolución de llamada, thisArg) Enumera todos los documentos en QuerySnapshot.

Instantánea.docs

Un array de todos los documentos en QuerySnapshot.

Firma:

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

QuerySnapshot.vacío

Es verdadero si no hay documentos en QuerySnapshot.

Firma:

get empty(): boolean;

Instantánea.metadatos

Metadatos sobre esta instantánea, en relación con su fuente y si tiene modificaciones locales.

Firma:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

La consulta en la que llamaste a get o onSnapshot para obtener este QuerySnapshot.

Firma:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

La cantidad de documentos en QuerySnapshot.

Firma:

get size(): number;

QuerySnapshot.docChanges()

Muestra un array de los cambios en los documentos desde la última instantánea. Si esta es la primera instantánea, todos los documentos aparecerán en la lista como “agregados”. cambios.

Firma:

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

Parámetros

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

Muestra:

Arreglo<DocumentChange<AppModelType, DrModelType>>

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
callback (resultado: QueryDocumentSnapshot<AppModelType, DrModelType>) => anular Una devolución de llamada que se llamará con un QueryDocumentSnapshot para cada documento de la instantánea.
este Arg desconocido Es la vinculación this para la devolución de llamada.

Muestra:

void