AggregateQuerySnapshot

AggregateQuerySnapshot

The results of executing an aggregation query.

Constructor

new AggregateQuerySnapshot(_query, _readTime, _data)

Parameters:
Name Type Description
_query

The query that was executed to produce this result.

_readTime

The time this snapshot was read.

_data

The results of the aggregations performed over the underlying query.

Members

query

The query that was executed to produce this result.

readTime

The time this snapshot was read.

Methods

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.

Returns:
Type Description

The results of the aggregations performed over the underlying query.

isEqual(other)

Compares this object with the given object for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have the same data and their underlying queries compare "equal" using AggregateQuery.isEqual().

Parameters:
Name Type Description
other

The object to compare to this object for equality.

Returns:
Type Description

true if this object is "equal" to the given object, as defined above, or false otherwise.