Home > @i2analyze/i2connect > settings > getString

settings.getString() function

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

Signature:

function getString(path: string, isRequired: true): string;

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 string.

Returns:

string

The string value.