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 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

Métodos

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.metadata

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

Firma:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

La consulta en la que llamó get o onSnapshot para obtener esta QuerySnapshot .

Firma:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

El número de documentos en QuerySnapshot .

Firma:

get size(): number;

QuerySnapshot.docChanges()

Devuelve una matriz de los 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

Devoluciones:

Array< DocumentoCambiar <Tipo de modelo de aplicación, Tipo de modelo de base de datos>>

QuerySnapshot.forEach()

Enumera todos los documentos en QuerySnapshot .

Firma:

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

Parámetros

Devoluciones:

vacío