firestore_.aggregatequerysnapshot.md

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

AggregateQuerySnapshot class

The results of executing an aggregation query.

Signature:

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

Properties

Property	Modifiers	Type	Description
query		Query<AppModelType, DbModelType>	The underlying query over which the aggregations recorded in this AggregateQuerySnapshot were performed.
type		(not declared)	A type string to uniquely identify instances of this class.

Methods

Method	Modifiers	Description
data()		Returns the results of the aggregations performed over the underlying query.The keys of the returned object will be the same as those of the AggregateSpec object specified to the aggregation method, and the values will be the corresponding aggregation result.

AggregateQuerySnapshot.query

The underlying query over which the aggregations recorded in this AggregateQuerySnapshot were performed.

Signature:

readonly query: Query<AppModelType, DbModelType>;

AggregateQuerySnapshot.type

A type string to uniquely identify instances of this class.

Signature:

readonly type = "AggregateQuerySnapshot";

AggregateQuerySnapshot.data()

Returns the results of the aggregations performed over the underlying query.

The keys of the returned object will be the same as those of the AggregateSpec object specified to the aggregation method, and the values will be the corresponding aggregation result.

Signature:

data(): AggregateSpecData<AggregateSpecType>;

Returns:

AggregateSpecData<AggregateSpecType>

The results of the aggregations performed over the underlying query.