AggregateQuerySnapshot class

Os resultados da execução de uma consulta de agregação.

Assinatura:

export declare class AggregateQuerySnapshot<AggregateSpecType extends AggregateSpec, AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

Propriedades

Propriedade Modificadores Tipo Descrição
consulta Consulta <AppModelType, DbModelType> A consulta subjacente sobre a qual as agregações registradas neste AggregateQuerySnapshot foram executadas.
tipo (Não Declarado) Uma string de tipo para identificar exclusivamente instâncias desta classe.

Métodos

Método Modificadores Descrição
dados() Retorna os resultados das agregações realizadas na consulta subjacente. As chaves do objeto retornado serão as mesmas do objeto AggregateSpec especificado para o método de agregação e os valores serão o resultado da agregação correspondente.

AggregateQuerySnapshot.query

A consulta subjacente sobre a qual as agregações registradas neste AggregateQuerySnapshot foram executadas.

Assinatura:

readonly query: Query<AppModelType, DbModelType>;

AggregateQuerySnapshot.type

Uma string de tipo para identificar exclusivamente instâncias desta classe.

Assinatura:

readonly type = "AggregateQuerySnapshot";

AggregateQuerySnapshot.data()

Retorna os resultados das agregações realizadas na consulta subjacente.

As chaves do objeto retornado serão as mesmas do objeto AggregateSpec especificado para o método de agregação e os valores serão o resultado da agregação correspondente.

Assinatura:

data(): AggregateSpecData<AggregateSpecType>;

Retorna:

AggregateSpecData <AgregateSpecType>

Os resultados das agregações realizadas na consulta subjacente.