Home > @i2analyze/i2connect > settings > getString

settings.getString() 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 value from a setting, or undefined if the setting is missing or not a string.

Signature:

function getString(config: IGetSettingConfig): string | undefined;

Introduced: API version 2.0

Parameters

Parameter	Type	Description
config	IGetSettingConfig	The setting whose value is to be retrieved.

Returns:

string | undefined

The string value, or undefined.