docs: specify that select() cannot be used with listeners (#1093)

googleapis · May 27, 2020 · 4f4574a · 4f4574a
1 parent 7acdd7e
commit 4f4574a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/dev/src/reference.ts b/dev/src/reference.ts
@@ -1281,6 +1281,9 @@ export class Query<T = DocumentData> {
    * You can specify a list of field paths to return, or use an empty list to
    * only return the references of matching documents.
    *
+   * Queries that contain field masks cannot be listened to via `onSnapshot()`
+   * listeners.
+   *
    * This function returns a new (immutable) instance of the Query (rather than
    * modify the existing instance) to impose the field mask.
    *

diff --git a/types/firestore.d.ts b/types/firestore.d.ts
@@ -943,6 +943,9 @@ declare namespace FirebaseFirestore {
      * specify a list of field paths to return, or use an empty list to only
      * return the references of matching documents.
      *
+     * Queries that contain field masks cannot be listened to via `onSnapshot()`
+     * listeners.
+     *
      * This function returns a new (immutable) instance of the Query (rather
      * than modify the existing instance) to impose the field mask.
      *