Merge 8b71237 into 5dfd5b9

Author: MarkDuckworth

packages/firestore/src/api/cache_config.ts

@@ -248,6 +248,8 @@ export function memoryLocalCache(
 
 /**
  * An settings object to configure an `PersistentLocalCache` instance.
+ *
+ * Persistent cache cannot be used in a Node.js environment.
  */
 export type PersistentCacheSettings = {
   /**
@@ -271,6 +273,8 @@ export type PersistentCacheSettings = {
 /**
  * Creates an instance of `PersistentLocalCache`. The instance can be set to
  * `FirestoreSettings.cache` to tell the SDK which cache layer to use.
+ *
+ * Persistent cache cannot be used in a Node.js environment.
  */
 export function persistentLocalCache(
   settings?: PersistentCacheSettings

packages/firestore/src/api/database.ts

@@ -320,6 +320,8 @@ export function configureFirestore(firestore: Firestore): void {
  *   * unimplemented: The browser is incompatible with the offline
  *     persistence implementation.
  *
+ * Persistence cannot be used in a Node.js environment.
+ *
  * @param firestore - The {@link Firestore} instance to enable persistence for.
  * @param persistenceSettings - Optional settings object to configure
  * persistence.

packages/firestore/src/api/settings.ts

@@ -25,6 +25,8 @@ export { DEFAULT_HOST } from '../lite-api/settings';
 /**
  * Settings that can be passed to `enableIndexedDbPersistence()` to configure
  * Firestore persistence.
+ *
+ * Persistence cannot be used in a Node.js environment.
  */
 export interface PersistenceSettings {
   /**