Home > @i2analyze/i2connect > settings > getBoolean
settings.getBoolean() function
Warning: This API is now obsolete.
Version 2.1 of the API introduces an updated configuration mechanism. This function will be removed in the next major version of the API.
Gets a Boolean value from a setting, or undefined
if the setting is missing or not a Boolean.
Signature:
function getBoolean(config: IGetSettingConfig): boolean | undefined;
Introduced: API version 2.0
Parameters
Parameter | Type | Description |
---|---|---|
config | IGetSettingConfig | The setting whose value is to be retrieved. |
Returns:
boolean | undefined
The Boolean value, or undefined
.