API Reference > core-backend > Workspace > Settings > getObject

getObject Method

Overloads
getObject<T extends object>(settingName)  
getObject<T extends object>(settingName, defaultValue)  

getObject<T extends object>(settingName)

getObject<T extends object>(settingName: string): undefined | T

Parameter Type Description
settingName string  

Returns - undefined | T



getObject<T extends object>(settingName, defaultValue)

Get an object setting by SettingName.

getObject<T extends object>(settingName: string, defaultValue: T): T

Parameter Type Description
settingName string The name of the setting
defaultValue T value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an object.

Returns - T


Last Updated: 20 June, 2023