AggregateQuerySnapshot class

集計クエリの実行結果。

署名:

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

プロパティ

プロパティ 修飾キー タイプ 説明
query Query<AppModelType、DbModelType> この AggregateQuerySnapshot に記録された集計の実行に使用された基となるクエリ。
type (未申告) このクラスのインスタンスを一意に識別する文字列型。

メソッド

メソッド 修飾キー 説明
data() 基になるクエリに対して実行された集計の結果を返します。返されるオブジェクトのキーは、集計メソッドに指定された AggregateSpec オブジェクトのキーと同じになり、値は対応する集計結果になります。

AggregateQuerySnapshot.query

この AggregateQuerySnapshot に記録された集計の実行に使用された基となるクエリ。

署名:

readonly query: Query<AppModelType, DbModelType>;

AggregateQuerySnapshot.type

このクラスのインスタンスを一意に識別する文字列型。

署名:

readonly type = "AggregateQuerySnapshot";

AggregateQuerySnapshot.data()

基になるクエリに対して実行された集計の結果を返します。

返されるオブジェクトのキーは、集計メソッドに指定された AggregateSpec オブジェクトのキーと同じになり、値は対応する集計結果になります。

署名:

data(): AggregateSpecData<AggregateSpecType>;

戻り値:

AggregateSpecData<AggregateSpecType>

基になるクエリに対して実行された集計の結果。