Home > @i2analyze/i2connect > settings > getStringArray

settings.getStringArray() function

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

Signature:

function getStringArray(path: string, isRequired: true): string[];

Introduced: API version 2.0

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

Returns:

string[]

The string array.