docs-devsite/firestore_lite.settings.md
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 %}
Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.
<b>Signature:</b>
export declare interface Settings
| Property | Type | Description |
|---|---|---|
| host | string | The hostname to connect to. |
| ignoreUndefinedProperties | boolean | Whether to skip nested properties that are set to <code>undefined</code> during object serialization. If set to <code>true</code>, these properties are skipped and not written to Firestore. If set to <code>false</code> or omitted, the SDK throws an exception when it encounters properties of type <code>undefined</code>. |
| ssl | boolean | Whether to use SSL when connecting. |
The hostname to connect to.
<b>Signature:</b>
host?: string;
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<!-- -->.
<b>Signature:</b>
ignoreUndefinedProperties?: boolean;
Whether to use SSL when connecting.
<b>Signature:</b>
ssl?: boolean;