QuerySnapshot class

Um QuerySnapshot contém zero ou mais objetos DocumentSnapshot que representam os resultados de uma consulta. Os documentos podem ser acessados ​​como um array por meio da propriedade docs ou enumerados usando o método forEach . O número de documentos pode ser determinado por meio das propriedades empty e size .

Assinatura:

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

Propriedades

Métodos

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

Metadados sobre este snapshot, sobre sua origem e se possui modificações locais.

Assinatura:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

A consulta na qual você chamou get ou onSnapshot para obter este QuerySnapshot .

Assinatura:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

O número de documentos no QuerySnapshot .

Assinatura:

get size(): number;

QuerySnapshot.docChanges()

Retorna uma matriz das alterações de documentos desde o último instantâneo. Se este for o primeiro instantâneo, todos os documentos estarão na lista como alterações 'adicionadas'.

Assinatura:

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

Parâmetros

Retorna:

Array< DocumentChange <AppModelType, DbModelType>>

QuerySnapshot.forEach()

Enumera todos os documentos no QuerySnapshot .

Assinatura:

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

Parâmetros

Retorna:

vazio