Home > @i2analyze/i2connect > settings > getNumber

settings.getNumber() function

Gets a numeric value from a setting, or undefined if the setting is missing or not a number.

Signature:

function getNumber(path: string): number | undefined;

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.

Returns:

number | undefined

The numeric value, or undefined.