Home > @i2analyze/i2connect > settings > getBoolean

settings.getBoolean() function

Gets a Boolean value from a setting, or throws an Error if the setting is missing or not a Boolean.

Signature:

function getBoolean(path: string, isRequired: true): boolean;

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.
isRequired	true	true to throw an exception rather than return undefined if config does not specify a valid Boolean.

Returns:

boolean

The Boolean value.