Home > @i2analyze/i2connect > settings > getObject
settings.getObject() 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 an object from a setting, or undefined
if the setting is missing or not an object.
Signature:
function getObject<TValue = unknown>(config: IGetSettingConfig): TValue | undefined;
Introduced: API version 2.0
Type Parameters
Parameter | Type | Description |
---|---|---|
TValue | any(default: unknown) | The type of the object to retrieve. |
Parameters
Parameter | Type | Description |
---|---|---|
config | IGetSettingConfig | The setting whose value is to be retrieved. |
Returns:
TValue | undefined
The object, or undefined
.