From ad6b923c9208713efcf1c3053d8803f9f15d4d35 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Thu, 21 May 2020 09:49:30 -0700 Subject: [PATCH] docs: use the Web SDK docs for ignoreUndefinedProperties (#1086) --- dev/src/types.ts | 9 ++++----- types/firestore.d.ts | 7 +++---- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/dev/src/types.ts b/dev/src/types.ts index b51ff37ff..a2ae70988 100644 --- 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 index 55e7b9870..efa36799d 100644 --- 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;