Back to Firebase Js Sdk

PersistenceSettings interface

docs-devsite/firestore_.persistencesettings.md

12.12.11.4 KB
Original Source

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 %}

PersistenceSettings interface

Settings that can be passed to enableIndexedDbPersistence() to configure Firestore persistence.

Persistence cannot be used in a Node.js environment.

<b>Signature:</b>

typescript
export declare interface PersistenceSettings 

Properties

PropertyTypeDescription
forceOwnershipbooleanWhether to force enable persistence for the client. This cannot be used with multi-tab synchronization and is primarily intended for use with Web Workers. Setting this to <code>true</code> will enable persistence, but cause other tabs using persistence to fail.

PersistenceSettings.forceOwnership

Whether to force enable persistence for the client. This cannot be used with multi-tab synchronization and is primarily intended for use with Web Workers. Setting this to true will enable persistence, but cause other tabs using persistence to fail.

<b>Signature:</b>

typescript
forceOwnership?: boolean;