AggregateQuerySnapshot class

Результаты выполнения запроса агрегации.

Подпись:

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

Характеристики

Свойство Модификаторы Тип Описание
запрос Запрос <AppModelType, DbModelType> Базовый запрос, по которому выполнялись агрегаты, записанные в этом AggregateQuerySnapshot .
тип (не заявлено) Строка типа для уникальной идентификации экземпляров этого класса.

Методы

Метод Модификаторы Описание
данные() Возвращает результаты агрегатов, выполненных по базовому запросу. Ключи возвращаемого объекта будут такими же, как у объекта AggregateSpec , указанного для метода агрегации, а значения будут соответствующим результатом агрегации.

AggregateQuerySnapshot.query

Базовый запрос, по которому выполнялись агрегаты, записанные в этом AggregateQuerySnapshot .

Подпись:

readonly query: Query<AppModelType, DbModelType>;

AggregateQuerySnapshot.type

Строка типа для уникальной идентификации экземпляров этого класса.

Подпись:

readonly type = "AggregateQuerySnapshot";

AggregateQuerySnapshot.data()

Возвращает результаты агрегатов, выполненных по базовому запросу.

Ключи возвращаемого объекта будут такими же, как у объекта AggregateSpec , указанного для метода агрегации, а значения будут соответствующим результатом агрегации.

Подпись:

data(): AggregateSpecData<AggregateSpecType>;

Возврат:

АгрегатеСпецДанные <ТипАгрегатнойСпецификации>

Результаты агрегатов, выполненных по базовому запросу.