Settings interface
Stay organized with collections
Save and categorize content based on your preferences.
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 |
The hostname to connect to. |
| 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. |
| ssl |
boolean |
Whether to use SSL when connecting. |
Settings.host
The hostname to connect to.
Signature:
host?: string;
Settings.ignoreUndefinedProperties
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.
Signature:
ignoreUndefinedProperties?: boolean;
Settings.ssl
Whether to use SSL when connecting.
Signature:
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-22 UTC.
[null,null,["Last updated 2022-07-22 UTC."],[],[],null,["Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.\n\n**Signature:** \n\n export declare interface Settings \n\nProperties\n\nSettings.host\n\nThe hostname to connect to.\n\n**Signature:** \n\n host?: string;\n\nSettings.ignoreUndefinedProperties\n\nWhether 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`.\n\n**Signature:** \n\n ignoreUndefinedProperties?: boolean;\n\nSettings.ssl\n\nWhether to use SSL when connecting.\n\n**Signature:** \n\n ssl?: boolean;"]]
