Example code.

Author: MarkDuckworth

common/api-review/firestore-lite.api.md

@@ -18,7 +18,7 @@ export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unkn
 };
 
 // @public
-export class AggregateField<R> {
+export class AggregateField<T> {
     readonly type = "AggregateField";
 }
 

common/api-review/firestore.api.md

@@ -18,7 +18,7 @@ export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unkn
 };
 
 // @public
-export class AggregateField<R> {
+export class AggregateField<T> {
     readonly type = "AggregateField";
 }
 

packages/firestore/src/api/aggregate.ts

@@ -85,6 +85,18 @@ export function getCountFromServer(
  * @param aggregateSpec An `AggregateSpec` object that specifies the aggregates
  * to perform over the result set. The AggregateSpec specifies aliases for each
  * aggregate, which can be used to retrieve the aggregate result.
+ * @example
+ * ```typescript
+ * const aggregateSnapshot = await getAggregateFromServer(query, {
+ *   countOfDocs: count(),
+ *   totalHours: sum('hours'),
+ *   averageScore: average('score')
+ * });
+ *
+ * const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
+ * const totalHours: number = aggregateSnapshot.data().totalHours;
+ * const averageScore: number | null = aggregateSnapshot.data().averageScore;
+ * ```
  * @internal TODO (sum/avg) remove when public
  */
 export function getAggregateFromServer<T extends AggregateSpec>(

packages/firestore/src/lite-api/aggregate.ts

@@ -72,6 +72,18 @@ export function getCount(
  * @param aggregateSpec An `AggregateSpec` object that specifies the aggregates
  * to perform over the result set. The AggregateSpec specifies aliases for each
  * aggregate, which can be used to retrieve the aggregate result.
+ * @example
+ * ```typescript
+ * const aggregateSnapshot = await getAggregate(query, {
+ *   countOfDocs: count(),
+ *   totalHours: sum('hours'),
+ *   averageScore: average('score')
+ * });
+ *
+ * const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
+ * const totalHours: number = aggregateSnapshot.data().totalHours;
+ * const averageScore: number | null = aggregateSnapshot.data().averageScore;
+ * ```
  * @internal TODO (sum/avg) remove when public
  */
 export function getAggregate<T extends AggregateSpec>(