Stay organized with collections
Save and categorize content based on your preferences.
Properties
Optional cacheSizeBytes
cacheSizeBytes: number
Optional host
host: string
Optional ignoreUndefinedProperties
ignoreUndefinedProperties: boolean
Optional merge
merge: boolean
Optional ssl
ssl: boolean
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-27 UTC.
[null,null,["Last updated 2022-07-27 UTC."],[],[],null,["- [firebase](/docs/reference/node/firebase).\n- [firestore](/docs/reference/node/firebase.firestore).\n- Settings \nSpecifies custom configurations for your Cloud Firestore instance.\nYou must set these before invoking any other methods.\n\nIndex\n\nProperties\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\nOptional cacheSizeBytes \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\nOptional host \nhost: string \nThe hostname to connect to.\n\nOptional ignoreUndefinedProperties \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\nOptional merge \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\nOptional ssl \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.