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 size is not a
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.
Optional host
host:string
The hostname to connect to.
Optional ignoreUndefinedProperties
ignoreUndefinedProperties:boolean
Whether to skip nested properties that are set to undefined during
object serialization. If set to true, these properties are skipped
and not written to Firestore. If set to false or omitted, the SDK
throws an exception when it encounters properties of type undefined.
Optional merge
merge:boolean
Whether to merge the provided settings with the existing settings. If
set to true, the settings are merged with existing settings. If
set to false or left unset, the settings replace the existing
settings.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-07-27 UTC."],[],[],null,["# Settings | JavaScript SDK\n\n- [firebase](/docs/reference/node/firebase).\n- [firestore](/docs/reference/node/firebase.firestore).\n- Settings\n===============================================================================================================\n\nSpecifies custom configurations for your Cloud Firestore instance.\nYou must set these before invoking any other methods.\n\nIndex\n-----\n\n### Properties\n\n- [cacheSizeBytes](/docs/reference/node/firebase.firestore.Settings#cachesizebytes)\n- [host](/docs/reference/node/firebase.firestore.Settings#host)\n- [ignoreUndefinedProperties](/docs/reference/node/firebase.firestore.Settings#ignoreundefinedproperties)\n- [merge](/docs/reference/node/firebase.firestore.Settings#merge)\n- [ssl](/docs/reference/node/firebase.firestore.Settings#ssl)\n\nProperties\n----------\n\n### Optional cacheSizeBytes\n\ncacheSizeBytes: number \nAn approximate cache size threshold for the on-disk data. If the cache grows beyond this\nsize, Firestore will start removing data that hasn't been recently used. The size is not a\nguarantee that the cache will stay below that size, only that if the cache exceeds the given\nsize, cleanup will be attempted.\n\nThe default value is 40 MB. The threshold must be set to at least 1 MB, and can be set to\nCACHE_SIZE_UNLIMITED to disable garbage collection.\n\n### Optional host\n\nhost: string \nThe hostname to connect to.\n\n### Optional ignoreUndefinedProperties\n\nignoreUndefinedProperties: boolean \nWhether to skip nested properties that are set to `undefined` during\nobject serialization. If set to `true`, these properties are skipped\nand not written to Firestore. If set to `false` or omitted, the SDK\nthrows an exception when it encounters properties of type `undefined`.\n\n### Optional merge\n\nmerge: boolean \nWhether to merge the provided settings with the existing settings. If\nset to `true`, the settings are merged with existing settings. If\nset to `false` or left unset, the settings replace the existing\nsettings.\n\n### Optional ssl\n\nssl: boolean \nWhether to use SSL when connecting."]]
Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.