Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Config

The files where sfdx config values are stored for projects and the global space.

Note: It is not recommended to instantiate this object directly when resolving config values. Instead use ConfigAggregator

const localConfig = await Config.create({});
localConfig.set('defaultusername', 'username@company.org');
await localConfig.write();

https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_config_values.htm

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected options

options: Options

Static API_VERSION

API_VERSION: "apiVersion" = "apiVersion"

The api version

Static DEFAULT_DEV_HUB_USERNAME

DEFAULT_DEV_HUB_USERNAME: string = "defaultdevhubusername"

Username associated with the default dev hub org.

Static DEFAULT_USERNAME

DEFAULT_USERNAME: string = "defaultusername"

Username associate with the default org.

Static ISV_DEBUGGER_SID

ISV_DEBUGGER_SID: string = "isvDebuggerSid"

The sid for the debugger configuration.

Static ISV_DEBUGGER_URL

ISV_DEBUGGER_URL: string = "isvDebuggerUrl"

The url for the debugger configuration.

Methods

access

  • access(perm: number): Promise<boolean>

awaitEach

  • awaitEach(actionFn: function): Promise<void>
  • Asynchronously invokes actionFn once for each key-value pair present in the config object.

    Parameters

    • actionFn: function

      The function (key: string, value: ConfigValue) => Promise<void> to be called for each element.

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

clear

  • clear(): void

entries

exists

  • exists(): Promise<boolean>
  • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

    Returns Promise<boolean>

forEach

  • forEach(actionFn: function): void
  • Invokes actionFn once for each key-value pair present in the config object.

    Parameters

    • actionFn: function

      The function (key: string, value: ConfigValue) => void to be called for each element.

    Returns void

get

getContents

getKeysByValue

getPath

  • getPath(): string

has

  • has(key: string): boolean
  • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

    Parameters

    • key: string

      The key.

    Returns boolean

Protected init

  • init(): Promise<void>

isGlobal

  • isGlobal(): boolean

keys

  • keys(): string[]
  • Returns an array that contains the keys for each element in the config object.

    Returns string[]

read

set

setContents

setContentsFromObject

  • setContentsFromObject<U>(obj: U): void
  • Convert an object to a ConfigContents and set it as the config contents.

    Type parameters

    • U: any

    Parameters

    • obj: U

      The object.

    Returns void

Protected setMethod

stat

  • stat(): Promise<fsStats>

toObject

  • toObject(): JsonMap

unlink

  • unlink(): Promise<void>

unset

  • unset(key: string): boolean
  • Returns true if an element in the config object existed and has been removed, or false if the element does not exist. {@link BaseConfigStore.has} will return false afterwards.

    Parameters

    • key: string

      The key.

    Returns boolean

unsetAll

  • unsetAll(keys: string[]): boolean
  • Returns true if all elements in the config object existed and have been removed, or false if all the elements do not exist (some may have been removed). {@link BaseConfigStore.has(key)} will return false afterwards.

    Parameters

    • keys: string[]

      The keys.

    Returns boolean

values

write

Static clear

  • clear(): Promise<void>
  • Clear all the configured properties both local and global.

    Returns Promise<void>

Static create

  • create<P, T>(this: object, options: P): Promise<T>
  • Asynchronously constructs and initializes a new instance of a concrete subclass with the provided options.

    Type parameters

    • P

    • T: AsyncCreatable<P>

    Parameters

    • this: object
    • options: P

      An options object providing initialization params to the async constructor.

    Returns Promise<T>

Static getAllowedProperties

Static getDefaultOptions

  • getDefaultOptions(isGlobal?: boolean, filename?: undefined | string): Options

Static getFileName

  • getFileName(): string

Static resolveRootFolder

  • resolveRootFolder(isGlobal: boolean): Promise<string>
  • Helper used to determined what the local and global folder point to. Returns the file path of the root folder.

    Parameters

    • isGlobal: boolean

      True if the config should be global. False for local.

    Returns Promise<string>

Static update

  • The value of a supported config property.

    Parameters

    • isGlobal: boolean

      True for a global config. False for a local config.

    • propertyName: string

      The name of the property to set.

    • Optional value: ConfigValue

      The property value.

    Returns Promise<ConfigContents>