fix: change typings for select() to return Query<DocumentData> (#1303)

googleapis · Sep 22, 2020 · b678857 · b678857
1 parent 20b1226
commit b678857
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/dev/src/reference.ts b/dev/src/reference.ts
@@ -1290,7 +1290,9 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
    *   console.log(`y is ${res.docs[0].get('y')}.`);
    * });
    */
-  select(...fieldPaths: Array<string | FieldPath>): Query<T> {
+  select(
+    ...fieldPaths: Array<string | FieldPath>
+  ): Query<firestore.DocumentData> {
     const fields: api.StructuredQuery.IFieldReference[] = [];
 
     if (fieldPaths.length === 0) {
@@ -1304,7 +1306,11 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
       }
     }
 
-    const options = this._queryOptions.with({projection: {fields}});
+    // By specifying a field mask, the query result no longer conforms to type
+    // `T`. We there return `Query<DocumentData>`;
+    const options = this._queryOptions.with({
+      projection: {fields},
+    }) as QueryOptions<firestore.DocumentData>;
     return new Query(this._firestore, options);
   }
 

diff --git a/types/firestore.d.ts b/types/firestore.d.ts
@@ -1190,7 +1190,7 @@ declare namespace FirebaseFirestore {
      * @param field The field paths to return.
      * @return The created Query.
      */
-    select(...field: (string | FieldPath)[]): Query<T>;
+    select(...field: (string | FieldPath)[]): Query<DocumentData>;
 
     /**
      * Creates and returns a new Query that starts at the provided document