Home > @i2analyze/i2connect > settings > getBoolean

settings.getBoolean() function

Gets a Boolean value from a setting, or undefined if the setting is missing or not a Boolean.

Signature:

function getBoolean(path: string): boolean | undefined;

Introduced: API version 2.1

Parameters

Parameter	Type	Description
path	string	The path to the location of the setting within the config/settings.json file.

Returns:

boolean | undefined

The Boolean value, or undefined.