Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Aliases

Aliases specify alternate names for groups of properties used by the Salesforce CLI, such as orgs. By default, all aliases are stored under 'orgs', but groups allow aliases to be applied for other commands, settings, and parameters.

Note: All aliases are stored at the global level.

const aliases = await Aliases.create({});
aliases.set('myAlias', 'username@company.org');
await aliases.write();
// Shorthand to get an alias.
const username: string = await Aliases.fetch('myAlias');

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

Hierarchy

Implements

Index

Constructors

constructor

  • Constructor Do not directly construct instances of this class -- use Aliases.create instead.

    Parameters

    • options: Options

      The options for the class instance

    Returns Aliases

Properties

Protected defaultGroup

defaultGroup: string = "default"

Protected options

options: Options

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

getGroup

getInGroup

  • getInGroup(key: string, group?: undefined | string): Optional<ConfigValue>
  • Returns the value associated to the key and group, or undefined if there is none.

    Parameters

    • key: string

      The key.

    • Optional group: undefined | string

      The group. Defaults to the default group.

    Returns Optional<ConfigValue>

getKeysByValue

getPath

  • getPath(): string

has

  • has(key: string): boolean
  • Returns a boolean if an element with the specified key exists in the default group.

    Parameters

    • key: string

      The key.

    Returns boolean

init

  • init(): Promise<void>

isGlobal

  • isGlobal(): boolean

keys

  • keys(): string[]

read

  • Read the config file and set the config contents. Returns the config contents of the config file. Throws SfdxError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

    Parameters

    • Default value throwOnNotFound: boolean = false

    Returns Promise<ConfigContents>

set

setContents

setContentsFromObject

  • setContentsFromObject<U>(obj: U): void

setDefaultGroup

  • setDefaultGroup(group: string): void

setInGroup

Protected setMethod

stat

  • stat(): Promise<fsStats>

toObject

  • toObject(): JsonMap

unlink

  • unlink(): Promise<void>

unset

  • unset(key: string): boolean
  • Removes an element with the specified key from the default group. Returns true if the item was deleted.

    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

updateValue

  • updateValue(key: string, value: ConfigValue, group?: undefined | string): Promise<void>

updateValues

  • updateValues(newEntries: Dictionary<ConfigValue>, group?: undefined | string): Promise<Dictionary<ConfigValue>>
  • Set a group of entries in a bulk save. Returns The new properties that were saved.

    Parameters

    • newEntries: Dictionary<ConfigValue>

      An object representing the aliases to set.

    • Optional group: undefined | string

      The group the property belongs to.

    Returns Promise<Dictionary<ConfigValue>>

values

write

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 fetch

  • fetch(key: string, group?: ORGS): Promise<Optional<string>>
  • Get an alias from a key and group. Shorthand for Alias.create({}).get(key). Returns the promise resolved when the alias is created.

    Parameters

    • key: string

      The value of the alias to match.

    • Default value group: ORGS = AliasGroup.ORGS

      The group the alias belongs to. Defaults to Orgs.

    Returns Promise<Optional<string>>

Static getDefaultOptions

Static getFileName

  • getFileName(): string

Static getOptions

  • getOptions(defaultGroup: string, filename?: undefined | string): Options
  • Get ConfigGroup specific options, such as the default group.

    Parameters

    • defaultGroup: string

      The default group to use when creating the config.

    • Optional filename: undefined | string

      The filename of the config file. Uses the static getFileName by default.

    Returns Options

Static parseAndUpdate

  • parseAndUpdate(aliasKeyAndValues: string[], group?: AliasGroup): Promise<JsonMap>
  • Updates a group of aliases in a bulk save and returns the new aliases that were saved.

    const aliases = await Aliases.parseAndUpdate(['foo=bar', 'bar=baz'])

    Parameters

    • aliasKeyAndValues: string[]

      An array of strings in the format <alias>=<value>. Each element will be saved in the Aliases state file under the group.

    • Default value group: AliasGroup = AliasGroup.ORGS

      The group the alias belongs to. Defaults to ORGS.

    Returns Promise<JsonMap>

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>