Update firestore docs for typos (#7173)

dwyfrequency · web-flow · commit 8c9f8c83e1d0 · 2023-03-31T12:07:36.000-04:00
* Update firestore docs for typos

* Revert auth change
diff --git a/docs-devsite/firestore_.firestoresettings.md b/docs-devsite/firestore_.firestoresettings.md
@@ -27,7 +27,7 @@ export declare interface FirestoreSettings
 |  [experimentalForceLongPolling](./firestore_.firestoresettings.md#firestoresettingsexperimentalforcelongpolling) | boolean | Forces the SDK’s underlying network transport (WebChannel) to use long-polling. Each response from the backend will be closed immediately after the backend sends data (by default responses are kept open in case the backend has more data to send). This avoids incompatibility issues with certain proxies, antivirus software, etc. that incorrectly buffer traffic indefinitely. Use of this option will cause some performance degradation though.<!-- -->This setting cannot be used with <code>experimentalAutoDetectLongPolling</code> and may be removed in a future release. If you find yourself using it to work around a specific network reliability issue, please tell us about it in https://github.com/firebase/firebase-js-sdk/issues/1674. |
 |  [host](./firestore_.firestoresettings.md#firestoresettingshost) | string | The hostname to connect to. |
 |  [ignoreUndefinedProperties](./firestore_.firestoresettings.md#firestoresettingsignoreundefinedproperties) | boolean | Whether to skip nested properties that are set to <code>undefined</code> during object serialization. If set to <code>true</code>, these properties are skipped and not written to Firestore. If set to <code>false</code> or omitted, the SDK throws an exception when it encounters properties of type <code>undefined</code>. |
-|  [localCache](./firestore_.firestoresettings.md#firestoresettingslocalcache) | [FirestoreLocalCache](./firestore_.md#firestorelocalcache) | Specifies the cache used by the SDK. Availabe options are <code>MemoryLocalCache</code> and <code>IndexedDbLocalCache</code>, each with different configuration options.<!-- -->When unspecified, <code>MemoryLocalCache</code> will be used by default.<!-- -->NOTE: setting this field and <code>cacheSizeBytes</code> at the same time will throw exception during SDK initialization. Instead, using the configuration in the <code>FirestoreLocalCache</code> object to specify the cache size. |
+|  [localCache](./firestore_.firestoresettings.md#firestoresettingslocalcache) | [FirestoreLocalCache](./firestore_.md#firestorelocalcache) | Specifies the cache used by the SDK. Available options are <code>MemoryLocalCache</code> and <code>IndexedDbLocalCache</code>, each with different configuration options.<!-- -->When unspecified, <code>MemoryLocalCache</code> will be used by default.<!-- -->NOTE: setting this field and <code>cacheSizeBytes</code> at the same time will throw exception during SDK initialization. Instead, using the configuration in the <code>FirestoreLocalCache</code> object to specify the cache size. |
 |  [ssl](./firestore_.firestoresettings.md#firestoresettingsssl) | boolean | Whether to use SSL when connecting. |
 
 ## FirestoreSettings.cacheSizeBytes
@@ -90,7 +90,7 @@ ignoreUndefinedProperties?: boolean;
 
 ## FirestoreSettings.localCache
 
-Specifies the cache used by the SDK. Availabe options are `MemoryLocalCache` and `IndexedDbLocalCache`<!-- -->, each with different configuration options.
+Specifies the cache used by the SDK. Available options are `MemoryLocalCache` and `IndexedDbLocalCache`<!-- -->, each with different configuration options.
 
 When unspecified, `MemoryLocalCache` will be used by default.
 
diff --git a/docs-devsite/firestore_.md b/docs-devsite/firestore_.md
@@ -157,9 +157,9 @@ https://github.com/firebase/firebase-js-sdk
 |  [PersistenceSettings](./firestore_.persistencesettings.md#persistencesettings_interface) | Settings that can be passed to <code>enableIndexedDbPersistence()</code> to configure Firestore persistence. |
 |  [PersistentCacheSettings](./firestore_.persistentcachesettings.md#persistentcachesettings_interface) | An settings object to configure an <code>PersistentLocalCache</code> instance. |
 |  [PersistentLocalCache](./firestore_.persistentlocalcache.md#persistentlocalcache_interface) | Provides a persistent cache backed by IndexedDb to the SDK.<!-- -->To use, create an instance using the factory function , then set the instance to <code>FirestoreSettings.cache</code> and call <code>initializeFirestore</code> using the settings object. |
-|  [PersistentMultipleTabManager](./firestore_.persistentmultipletabmanager.md#persistentmultipletabmanager_interface) | A tab manager supportting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK. |
+|  [PersistentMultipleTabManager](./firestore_.persistentmultipletabmanager.md#persistentmultipletabmanager_interface) | A tab manager supporting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK. |
 |  [PersistentSingleTabManager](./firestore_.persistentsingletabmanager.md#persistentsingletabmanager_interface) | A tab manager supportting only one tab, no synchronization will be performed across tabs. |
-|  [PersistentSingleTabManagerSettings](./firestore_.persistentsingletabmanagersettings.md#persistentsingletabmanagersettings_interface) | Type to configure an <code>PersistentSingleTabManager</code> instace. |
+|  [PersistentSingleTabManagerSettings](./firestore_.persistentsingletabmanagersettings.md#persistentsingletabmanagersettings_interface) | Type to configure an <code>PersistentSingleTabManager</code> instance. |
 |  [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md#snapshotlistenoptions_interface) | An options object that can be passed to [onSnapshot()](./firestore_.md#onsnapshot) and [QuerySnapshot.docChanges()](./firestore_.querysnapshot.md#querysnapshotdocchanges) to control which types of changes to include in the result set. |
 |  [SnapshotOptions](./firestore_.snapshotoptions.md#snapshotoptions_interface) | Options that configure how data is retrieved from a <code>DocumentSnapshot</code> (for example the desired behavior for server timestamps that have not yet been set to their final value). |
 |  [TransactionOptions](./firestore_.transactionoptions.md#transactionoptions_interface) | Options to customize transaction behavior. |
@@ -185,7 +185,7 @@ https://github.com/firebase/firebase-js-sdk
 |  [NestedUpdateFields](./firestore_.md#nestedupdatefields) | For each field (e.g. 'bar'), find all nested keys (e.g. {<!-- -->'bar.baz': T1, 'bar.qux': T2<!-- -->}<!-- -->). Intersect them together to make a single map containing all possible keys that are all marked as optional |
 |  [OrderByDirection](./firestore_.md#orderbydirection) | The direction of a [orderBy()](./firestore_.md#orderby) clause is specified as 'desc' or 'asc' (descending or ascending). |
 |  [PartialWithFieldValue](./firestore_.md#partialwithfieldvalue) | Similar to Typescript's <code>Partial&lt;T&gt;</code>, but allows nested fields to be omitted and FieldValues to be passed in as property values. |
-|  [PersistentTabManager](./firestore_.md#persistenttabmanager) | A union of all avaialbe tab managers. |
+|  [PersistentTabManager](./firestore_.md#persistenttabmanager) | A union of all available tab managers. |
 |  [Primitive](./firestore_.md#primitive) | Primitive types. |
 |  [QueryConstraintType](./firestore_.md#queryconstrainttype) | Describes the different query constraints available in this SDK. |
 |  [QueryFilterConstraint](./firestore_.md#queryfilterconstraint) | <code>QueryFilterConstraint</code> is a helper union type that represents [QueryFieldFilterConstraint](./firestore_.queryfieldfilterconstraint.md#queryfieldfilterconstraint_class) and [QueryCompositeFilterConstraint](./firestore_.querycompositefilterconstraint.md#querycompositefilterconstraint_class)<!-- -->. |
@@ -2208,7 +2208,7 @@ export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive
 
 ## PersistentTabManager
 
-A union of all avaialbe tab managers.
+A union of all available tab managers.
 
 <b>Signature:</b>
 
diff --git a/docs-devsite/firestore_.persistentmultipletabmanager.md b/docs-devsite/firestore_.persistentmultipletabmanager.md
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # PersistentMultipleTabManager interface
-A tab manager supportting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK.
+A tab manager supporting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK.
 
 <b>Signature:</b>
 
diff --git a/docs-devsite/firestore_.persistentsingletabmanagersettings.md b/docs-devsite/firestore_.persistentsingletabmanagersettings.md
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # PersistentSingleTabManagerSettings interface
-Type to configure an `PersistentSingleTabManager` instace.
+Type to configure an `PersistentSingleTabManager` instance.
 
 <b>Signature:</b>
 
diff --git a/packages/auth/api-extractor.json b/packages/auth/api-extractor.json
@@ -6,4 +6,4 @@
         "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
         "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
     }
-}
+}
diff --git a/packages/firestore/src/api/cache_config.ts b/packages/firestore/src/api/cache_config.ts
@@ -214,7 +214,7 @@ class SingleTabManagerImpl implements PersistentSingleTabManager {
 }
 
 /**
- * A tab manager supportting multiple tabs. SDK will synchronize queries and
+ * A tab manager supporting multiple tabs. SDK will synchronize queries and
  * mutations done across all tabs using the SDK.
  */
 export type PersistentMultipleTabManager = {
@@ -265,14 +265,14 @@ class MultiTabManagerImpl implements PersistentMultipleTabManager {
 }
 
 /**
- * A union of all avaialbe tab managers.
+ * A union of all available tab managers.
  */
 export type PersistentTabManager =
   | PersistentSingleTabManager
   | PersistentMultipleTabManager;
 
 /**
- * Type to configure an `PersistentSingleTabManager` instace.
+ * Type to configure an `PersistentSingleTabManager` instance.
  */
 export type PersistentSingleTabManagerSettings = {
   /**
diff --git a/packages/firestore/src/api/settings.ts b/packages/firestore/src/api/settings.ts
@@ -56,7 +56,7 @@ export interface FirestoreSettings extends LiteSettings {
   cacheSizeBytes?: number;
 
   /**
-   * Specifies the cache used by the SDK. Availabe options are `MemoryLocalCache`
+   * Specifies the cache used by the SDK. Available options are `MemoryLocalCache`
    * and `IndexedDbLocalCache`, each with different configuration options.
    *
    * When unspecified, `MemoryLocalCache` will be used by default.

Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,4 @@`
`6`	`6`	`"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",`
`7`	`7`	`"publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"`
`8`	`8`	`}`
`9`		`-}`
	`9`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ export interface FirestoreSettings extends LiteSettings {`
`56`	`56`	`cacheSizeBytes?: number;`
`57`	`57`
`58`	`58`	`/**`
`59`		- * Specifies the cache used by the SDK. Availabe options are `MemoryLocalCache`
	`59`	+ * Specifies the cache used by the SDK. Available options are `MemoryLocalCache`
`60`	`60`	* and `IndexedDbLocalCache`, each with different configuration options.
`61`	`61`	`*`
`62`	`62`	* When unspecified, `MemoryLocalCache` will be used by default.