docs: use the Web SDK docs for ignoreUndefinedProperties (#1086)

googleapis · May 21, 2020 · ad6b923 · ad6b923
1 parent 3153dd2
commit ad6b923
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 9 deletions.
diff --git a/dev/src/types.ts b/dev/src/types.ts
@@ -204,11 +204,10 @@ export interface Settings {
   maxIdleChannels?: number;
 
   /**
-   * Whether to skip nested properties that are set to `undefined` during object
-   * serialization. If set to `true`, these properties will be skipped and are
-   * not be written to Firestore. If the setting is set `false` or omitted,
-   * the SDK will throw an exception when it encounters properties of type
-   * `undefined`.
+   * Whether to skip nested properties that are set to `undefined` during
+   * object serialization. If set to `true`, these properties are skipped
+   * and not written to Firestore. If set `false` or omitted, the SDK throws
+   * an exception when it encounters properties of type `undefined`.
    */
   ignoreUndefinedProperties?: boolean;
 

diff --git a/types/firestore.d.ts b/types/firestore.d.ts
@@ -146,10 +146,9 @@ declare namespace FirebaseFirestore {
 
     /**
      * Whether to skip nested properties that are set to `undefined` during
-     * object serialization. If set to `true`, these properties will be skipped
-     * and are not be written to Firestore. If the setting is set `false` or
-     * omitted, the SDK will throw an exception when it encounters properties
-     * of type `undefined`.
+     * object serialization. If set to `true`, these properties are skipped
+     * and not written to Firestore. If set `false` or omitted, the SDK throws
+     * an exception when it encounters properties of type `undefined`.
      */
     ignoreUndefinedProperties?: boolean;