Home > @i2analyze/i2connect > settings > getObject
settings.getObject() function
Gets an object from a setting, or undefined if the setting is missing or not an object.
Signature:
function getObject<TValue = unknown>(path: string): 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 |
|---|---|---|
| path | string | The path to the location of the setting within the config/settings.json file. |
Returns:
TValue | undefined
The object, or undefined.