Home > @i2analyze/i2connect > settings > getStringArray
settings.getStringArray() 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 string array from a setting, or throws an Error
if the setting is missing or not a string array.
Signature:
function getStringArray(config: IGetSettingConfig, isRequired: true): string[];
Introduced: API version 2.0
Parameters
Parameter | Type | Description |
---|---|---|
config | IGetSettingConfig | The setting whose value is to be retrieved. |
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.