Home > @i2analyze/i2connect > settings
settings namespace
The members of the settings namespace allow you to retrieve connector settings from environment variables and the configuration file.
Signature:
export declare namespace settings
Introduced: API version 2.0
Functions
| Function | Description |
|---|---|
| getBoolean(path, isRequired) | Gets a Boolean value from a setting, or throws an Error if the setting is missing or not a Boolean. |
| getBoolean(path) | Gets a Boolean value from a setting, or undefined if the setting is missing or not a Boolean. |
| getBoolean(config, isRequired) | Gets a Boolean value from a setting, or throws an Error if the setting is missing or not a Boolean. |
| getBoolean(config) | Gets a Boolean value from a setting, or undefined if the setting is missing or not a Boolean. |
| getNumber(path, isRequired) | Gets a numeric value from a setting, or throws an Error if the setting is missing or not a number. |
| getNumber(path) | Gets a numeric value from a setting, or undefined if the setting is missing or not a number. |
| getNumber(config, isRequired) | Gets a numeric value from a setting, or throws an Error if the setting is missing or not a number. |
| getNumber(config) | Gets a numeric value from a setting, or undefined if the setting is missing or not a number. |
| getObject(path, isRequired) | Gets an object from a setting, or throws an Error if the setting is missing or not an object. |
| getObject(path) | Gets an object from a setting, or undefined if the setting is missing or not an object. |
| getObject(config, isRequired) | Gets an object from a setting, or throws an Error if the setting is missing or not an object. |
| getObject(config) | Gets an object from a setting, or undefined if the setting is missing or not an object. |
| getString(path, isRequired) | Gets a string value from a setting, or throws an Error if the setting is missing or not a string. |
| getString(path) | Gets a string value from a setting, or throws an Error if the setting is missing or not a string. |
| getString(config, isRequired) | Gets a string value from a setting, or throws an Error if the setting is missing or not a string. |
| getString(config) | Gets a string value from a setting, or undefined if the setting is missing or not a string. |
| getStringArray(path, isRequired) | Gets a string array from a setting, or throws an Error if the setting is missing or not a string array. |
| getStringArray(path) | Gets a string array from a setting, or undefined if the setting is missing or not a string array. |
| getStringArray(config, isRequired) | Gets a string array from a setting, or throws an Error if the setting is missing or not a string array. |
| getStringArray(config) | Gets a string array from a setting, or undefined if the setting is missing or not a string array. |
Interfaces
| Interface | Description |
|---|---|
| IGetSettingEnvVarConfig | A set of information that specifies a connector setting in an environment variable. |
| IGetSettingPathAndEnvVarConfig | A set of information that specifies a connector setting in the configuration file and an environment variable. |
| IGetSettingPathConfig | A set of information that specifies a connector setting in the configuration file. |
Type Aliases
| Type Alias | Description |
|---|---|
| IGetSettingConfig | A set of information that specifies a connector setting. |