The Firebase JS SDK is now in BETA!
This EAP site is no longer maintained. See the official Firebase Documentation site for the latest documentation and information about the Firebase JS SDK.

Home > @firebase/firestore > lite > Settings

Settings interface

Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.

Signature:

export declare interface Settings 

Properties

Property Type Description
host? string (Optional) The hostname to connect to.
ignoreUndefinedProperties? boolean (Optional) 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.
ssl? boolean (Optional) Whether to use SSL when connecting.