Class Config

constructor

• new Config(appAuthor, appName, definitions): Config

• Creates a new Config instance.

  Parameters

  • appAuthor: string

    The name of the author of the application.

  • appName: string

    The name of the application.

  • definitions: Record<string, IConfigSetting>

    Objects that define each setting of the user config.

  Returns Config

Readonly data

Readonly definitions

appdata

• get appdata(): Record<string, any>

• Returns Record<string, any>

userconfig

• get userconfig(): Record<string, any>

• Returns Record<string, any>

editConfigInEditor

• editConfigInEditor(): void

• Edits the user configuration in the editor.

  Returns void

initialize

• initialize(program): void

• Initializes the configuration settings.

  Parameters

  • program: Command

    The Commander program instance.

  Returns void

reset

• reset(setting?): void

• Resets a configuration setting.

  Parameters

  • Optional setting: string

    The name of the setting. If omitted, all settings are reset.

  Returns void

set

• set(setting, value): void

• Sets a configuration setting.

  Parameters

  • setting: string

    The name of the setting.

  • value: string

    The value to assign.

  Returns void