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

getArray Method

Overloads
getArray<T extends JSONSchemaType>(settingName)  
getArray<T extends JSONSchemaType>(settingName, defaultValue)  

getArray<T extends JSONSchemaType>(settingName)

getArray<T extends JSONSchemaType>(settingName: string): undefined | T[]

Parameter Type Description
settingName string  

Returns - undefined | T[]



getArray<T extends JSONSchemaType>(settingName, defaultValue)

Get an array setting by SettingName.

getArray<T extends JSONSchemaType>(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 array.

Returns - T[]


Last Updated: 20 June, 2023