Skip to content

Commit

Permalink
docs: tweak Count API docs (#1974)
Browse files Browse the repository at this point in the history
  • Loading branch information
dconeybe authored Jan 10, 2024
1 parent 8f77b68 commit a29d34a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
11 changes: 6 additions & 5 deletions dev/src/reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1839,8 +1839,8 @@ export class Query<
*
* Using the returned query to count the documents is efficient because only
* the final count, not the documents' data, is downloaded. The returned
* query can even count the documents if the result set would be
* prohibitively large to download entirely (e.g. thousands of documents).
* query can count the documents in cases where the result set is
* prohibitively large to download entirely (thousands of documents).
*
* @return a query that counts the documents in the result set of this
* query. The count can be retrieved from `snapshot.data().count`, where
Expand All @@ -1861,13 +1861,14 @@ export class Query<
* Returns a query that can perform the given aggregations.
*
* The returned query, when executed, calculates the specified aggregations
* over the documents in the result set of this query, without actually
* over the documents in the result set of this query without actually
* downloading the documents.
*
* Using the returned query to perform aggregations is efficient because only
* the final aggregation values, not the documents' data, is downloaded. The
* returned query can even perform aggregations of the documents if the result set
* would be prohibitively large to download entirely (e.g. thousands of documents).
* returned query can perform aggregations of the documents count the
* documents in cases where the result set is prohibitively large to download
* entirely (thousands of documents).
*
* @param aggregateSpec An `AggregateSpec` object that specifies the aggregates
* to perform over the result set. The AggregateSpec specifies aliases for each
Expand Down
11 changes: 6 additions & 5 deletions types/firestore.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1910,8 +1910,8 @@ declare namespace FirebaseFirestore {
*
* Using the returned query to count the documents is efficient because only
* the final count, not the documents' data, is downloaded. The returned
* query can even count the documents if the result set would be
* prohibitively large to download entirely (e.g. thousands of documents).
* query can count the documents in cases where the result set is
* prohibitively large to download entirely (thousands of documents).
*
* @return a query that counts the documents in the result set of this
* query. The count can be retrieved from `snapshot.data().count`, where
Expand All @@ -1928,13 +1928,14 @@ declare namespace FirebaseFirestore {
* Returns a query that can perform the given aggregations.
*
* The returned query, when executed, calculates the specified aggregations
* over the documents in the result set of this query, without actually
* over the documents in the result set of this query without actually
* downloading the documents.
*
* Using the returned query to perform aggregations is efficient because only
* the final aggregation values, not the documents' data, is downloaded. The
* returned query can even perform aggregations of the documents if the result set
* would be prohibitively large to download entirely (e.g. thousands of documents).
* returned query can perform aggregations of the documents in cases where
* the result set is prohibitively large to download entirely (thousands of
* documents).
*
* @param aggregateSpec An `AggregateSpec` object that specifies the aggregates
* to perform over the result set. The AggregateSpec specifies aliases for each
Expand Down

0 comments on commit a29d34a

Please sign in to comment.