The interface for Config options.

Hierarchy

Properties

encryptedKeys?: (string | RegExp)[]

Keys to encrypt.

The preferred way to set encrypted keys is to use BaseConfigStore.encryptedKeys so they are constant for all instances of a Config class. However, this is useful for instantiating subclasses of ConfigStore on the fly (like ConfigFile) without defining a new class.

filePath?: string

The full file path where the config file is stored.

filename?: string

The file name.

isGlobal?: boolean

If the file is in the global or project directory.

isState?: boolean

If the file is in the state folder or no (.sfdx).

rootFolder?: string

The root folder where the config file is stored.

stateFolder?: string

The state folder where the config file is stored.

throwOnNotFound?: boolean

Indicates if init should throw if the corresponding config file is not found.