Skip to main content

Interface: ISettingMap

model.ISettingMap

Table of contents​

Properties​

Properties​

defaultValue​

• Optional defaultValue: string

Default value of the setting.

Defined in​

src/model/settingsMap.ts:44

description​

• Optional description: string

Optional description of the setting, explaining its purpose or usage.

Defined in​

src/model/settingsMap.ts:54

displayName​

• displayName: string

The display name of the setting, used in user interfaces.

Defined in​

src/model/settingsMap.ts:29

enumValues​

• Optional enumValues: string[] | () => string[]

Optional array of possible values for the setting. Can be a static array or a function returning an array.

Defined in​

src/model/settingsMap.ts:39

isSecret​

• Optional isSecret: boolean

Indicates if the setting is a secret, such as a password or API key. (If true, the setting value will be masked in user interfaces.)

Defined in​

src/model/settingsMap.ts:59

name​

• name: string

The internal name of the setting.

Defined in​

src/model/settingsMap.ts:24

required​

• required: boolean

Indicates whether the setting is required.

Defined in​

src/model/settingsMap.ts:49

type​

• type: SettingType

The type of the setting, as defined in the SettingType enum.

Defined in​

src/model/settingsMap.ts:34