PersistentCacheSettings interface

An settings object to configure anPersistentLocalCache instance.

Persistent cache cannot be used in a Node.js environment.

Signature:

exportdeclareinterfacePersistentCacheSettings

Properties

PropertyTypeDescription
cacheSizeBytesnumberAn 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 toCACHE_SIZE_UNLIMITED to disable garbage collection.
tabManagerPersistentTabManagerSpecifies 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 toCACHE_SIZE_UNLIMITED to disable garbage collection.

Signature:

cacheSizeBytes?:number;

PersistentCacheSettings.tabManager

Specifies how multiple tabs/windows will be managed by the SDK.

Signature:

tabManager?:PersistentTabManager;

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-06-08 UTC.