Revert eslint change to fix firestore docs????

Author: dlarocque

common/api-review/firestore.api.md

@@ -375,14 +375,15 @@ export interface LoadBundleTaskProgress {
 export { LogLevel }
 
 // @public
-export type MemoryCacheSettings = {
+export interface MemoryCacheSettings {
     garbageCollector?: MemoryGarbageCollector;
-};
+}
 
 // @public
-export type MemoryEagerGarbageCollector = {
+export interface MemoryEagerGarbageCollector {
+    // (undocumented)
     kind: 'memoryEager';
-};
+}
 
 // @public
 export function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;
@@ -391,17 +392,19 @@ export function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;
 export type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;
 
 // @public
-export type MemoryLocalCache = {
+export interface MemoryLocalCache {
+    // (undocumented)
     kind: 'memory';
-};
+}
 
 // @public
 export function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;
 
 // @public
-export type MemoryLruGarbageCollector = {
+export interface MemoryLruGarbageCollector {
+    // (undocumented)
     kind: 'memoryLru';
-};
+}
 
 // @public
 export function memoryLruGarbageCollector(settings?: {
@@ -491,39 +494,42 @@ export class PersistentCacheIndexManager {
 }
 
 // @public
-export type PersistentCacheSettings = {
+export interface PersistentCacheSettings {
     cacheSizeBytes?: number;
     tabManager?: PersistentTabManager;
-};
+}
 
 // @public
-export type PersistentLocalCache = {
+export interface PersistentLocalCache {
+    // (undocumented)
     kind: 'persistent';
-};
+}
 
 // @public
 export function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;
 
 // @public
-export type PersistentMultipleTabManager = {
+export interface PersistentMultipleTabManager {
+    // (undocumented)
     kind: 'PersistentMultipleTab';
-};
+}
 
 // @public
 export function persistentMultipleTabManager(): PersistentMultipleTabManager;
 
 // @public
-export type PersistentSingleTabManager = {
+export interface PersistentSingleTabManager {
+    // (undocumented)
     kind: 'persistentSingleTab';
-};
+}
 
 // @public
 export function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;
 
 // @public
-export type PersistentSingleTabManagerSettings = {
+export interface PersistentSingleTabManagerSettings {
     forceOwnership?: boolean;
-};
+}
 
 // @public
 export type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

config/.eslintrc.js

@@ -174,6 +174,7 @@ module.exports = {
         }
       }
     ],
+    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
     '@typescript-eslint/explicit-member-accessibility': [
       'error',
       {

docs-devsite/_toc.yaml

@@ -245,10 +245,28 @@ toc:
     path: /docs/reference/js/firestore_.loadbundletask.md
   - title: LoadBundleTaskProgress
     path: /docs/reference/js/firestore_.loadbundletaskprogress.md
+  - title: MemoryCacheSettings
+    path: /docs/reference/js/firestore_.memorycachesettings.md
+  - title: MemoryEagerGarbageCollector
+    path: /docs/reference/js/firestore_.memoryeagergarbagecollector.md
+  - title: MemoryLocalCache
+    path: /docs/reference/js/firestore_.memorylocalcache.md
+  - title: MemoryLruGarbageCollector
+    path: /docs/reference/js/firestore_.memorylrugarbagecollector.md
   - title: PersistenceSettings
     path: /docs/reference/js/firestore_.persistencesettings.md
   - title: PersistentCacheIndexManager
     path: /docs/reference/js/firestore_.persistentcacheindexmanager.md
+  - title: PersistentCacheSettings
+    path: /docs/reference/js/firestore_.persistentcachesettings.md
+  - title: PersistentLocalCache
+    path: /docs/reference/js/firestore_.persistentlocalcache.md
+  - title: PersistentMultipleTabManager
+    path: /docs/reference/js/firestore_.persistentmultipletabmanager.md
+  - title: PersistentSingleTabManager
+    path: /docs/reference/js/firestore_.persistentsingletabmanager.md
+  - title: PersistentSingleTabManagerSettings
+    path: /docs/reference/js/firestore_.persistentsingletabmanagersettings.md
   - title: Query
     path: /docs/reference/js/firestore_.query.md
   - title: QueryCompositeFilterConstraint

docs-devsite/firestore_.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# MemoryCacheSettings interface
+An settings object to configure an `MemoryLocalCache` instance.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface MemoryCacheSettings 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [garbageCollector](./firestore_.memorycachesettings.md#memorycachesettingsgarbagecollector) | [MemoryGarbageCollector](./firestore_.md#memorygarbagecollector) | The garbage collector to use, for the memory cache layer. A <code>MemoryEagerGarbageCollector</code> is used when this is undefined. |
+
+## MemoryCacheSettings.garbageCollector
+
+The garbage collector to use, for the memory cache layer. A `MemoryEagerGarbageCollector` is used when this is undefined.
+
+<b>Signature:</b>
+
+```typescript
+garbageCollector?: MemoryGarbageCollector;
+```

docs-devsite/firestore_.memorycachesettings.md

@@ -0,0 +1,37 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# MemoryEagerGarbageCollector interface
+A garbage collector deletes documents whenever they are not part of any active queries, and have no local mutations attached to them.
+
+This collector tries to ensure lowest memory footprints from the SDK, at the risk of documents not being cached for offline queries or for direct queries to the cache.
+
+Use factory function  to create an instance of this collector.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface MemoryEagerGarbageCollector 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [kind](./firestore_.memoryeagergarbagecollector.md#memoryeagergarbagecollectorkind) | 'memoryEager' |  |
+
+## MemoryEagerGarbageCollector.kind
+
+<b>Signature:</b>
+
+```typescript
+kind: 'memoryEager';
+```

docs-devsite/firestore_.memoryeagergarbagecollector.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# MemoryLocalCache interface
+Provides an in-memory cache to the SDK. This is the default cache unless explicitly configured otherwise.
+
+To use, create an instance using the factory function , then set the instance to `FirestoreSettings.cache` and call `initializeFirestore` using the settings object.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface MemoryLocalCache 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [kind](./firestore_.memorylocalcache.md#memorylocalcachekind) | 'memory' |  |
+
+## MemoryLocalCache.kind
+
+<b>Signature:</b>
+
+```typescript
+kind: 'memory';
+```

docs-devsite/firestore_.memorylocalcache.md

@@ -0,0 +1,37 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# MemoryLruGarbageCollector interface
+A garbage collector deletes Least-Recently-Used documents in multiple batches.
+
+This collector is configured with a target size, and will only perform collection when the cached documents exceed the target size. It avoids querying backend repeated for the same query or document, at the risk of having a larger memory footprint.
+
+Use factory function  to create a instance of this collector.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface MemoryLruGarbageCollector 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [kind](./firestore_.memorylrugarbagecollector.md#memorylrugarbagecollectorkind) | 'memoryLru' |  |
+
+## MemoryLruGarbageCollector.kind
+
+<b>Signature:</b>
+
+```typescript
+kind: 'memoryLru';
+```

docs-devsite/firestore_.memorylrugarbagecollector.md

@@ -0,0 +1,50 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# PersistentCacheSettings interface
+An settings object to configure an `PersistentLocalCache` instance.
+
+Persistent cache cannot be used in a Node.js environment.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface PersistentCacheSettings 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [cacheSizeBytes](./firestore_.persistentcachesettings.md#persistentcachesettingscachesizebytes) | number | An approximate cache size threshold for the on-disk data. If the cache grows beyond this size, Firestore will start removing data that hasn't been recently used. The SDK does not guarantee that the cache will stay below that size, only that if the cache exceeds the given size, cleanup will be attempted.<!-- -->The default value is 40 MB. The threshold must be set to at least 1 MB, and can be set to <code>CACHE_SIZE_UNLIMITED</code> to disable garbage collection. |
+|  [tabManager](./firestore_.persistentcachesettings.md#persistentcachesettingstabmanager) | [PersistentTabManager](./firestore_.md#persistenttabmanager) | Specifies how multiple tabs/windows will be managed by the SDK. |
+
+## PersistentCacheSettings.cacheSizeBytes
+
+An approximate cache size threshold for the on-disk data. If the cache grows beyond this size, Firestore will start removing data that hasn't been recently used. The SDK does not guarantee that the cache will stay below that size, only that if the cache exceeds the given size, cleanup will be attempted.
+
+The default value is 40 MB. The threshold must be set to at least 1 MB, and can be set to `CACHE_SIZE_UNLIMITED` to disable garbage collection.
+
+<b>Signature:</b>
+
+```typescript
+cacheSizeBytes?: number;
+```
+
+## PersistentCacheSettings.tabManager
+
+Specifies how multiple tabs/windows will be managed by the SDK.
+
+<b>Signature:</b>
+
+```typescript
+tabManager?: PersistentTabManager;
+```

docs-devsite/firestore_.persistentcachesettings.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# 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 `FirestoreSettings.cache` and call `initializeFirestore` using the settings object.
+
+<b>Signature:</b>
+
+```typescript
+export declare interface PersistentLocalCache 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [kind](./firestore_.persistentlocalcache.md#persistentlocalcachekind) | 'persistent' |  |
+
+## PersistentLocalCache.kind
+
+<b>Signature:</b>
+
+```typescript
+kind: 'persistent';
+```