Class ConfigFile<T, P>

Represents a json config file used to manage settings and state. Global config files are stored in the home directory hidden state folder (.sfdx) and local config files are stored in the project path, either in the hidden state folder or wherever specified.

class MyConfig extends ConfigFile {
  public static getFileName(): string {
    return 'myConfigFilename.json';
  }
}
const myConfig = await MyConfig.create({
  isGlobal: true
});
myConfig.set('mykey', 'myvalue');
await myConfig.write();

Type Parameters

Hierarchy (view full)

Methods

access accessSync clear entries exists existsSync forEach get getContents getKeysByValue getPath has isGlobal keys read readSync set setContentsFromObject stat statSync toObject unlink unlinkSync unset unsetAll update values write writeSync getDefaultOptions getFileName resolveRootFolder resolveRootFolderSync

Methods

access

accessSync

clear

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>

existsSync

  • existsSync(): boolean

  • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

    Returns boolean

forEach

  • forEach(actionFn): void

  • Invokes actionFn once for each key-value pair present in the config object.

    Parameters

    • actionFn: ((key, value) => void)

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

        • (key, value): void

        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

get

  • get<K>(key, decrypt?): P[K]

  • Returns the value associated to the key, or undefined if there is none.

    Type Parameters

    • K extends string

    Parameters

    • key: K

      The key (object property)

    • Optional decrypt: boolean

      If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

    Returns P[K]

  • get<V>(key, decrypt?): V

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

getContents

  • getContents(decrypt?): Readonly<P>

  • Returns the entire config contents.

    NOTE: Data will still be encrypted unless decrypt is passed in. A clone of the data will be returned to prevent storing un-encrypted data in memory and potentially saving to the file system.

    Parameters

    • decrypt: boolean = false

    Returns Readonly<P>

getKeysByValue

getPath

  • getPath(): string

  • Returns the absolute path to the config file.

    The first time getPath is called, the path is resolved and becomes immutable. This allows implementers to override options properties, like filePath, on the init method for async creation. If that is required for creation, the config files can not be synchronously created.

    Returns string

has

isGlobal

  • isGlobal(): boolean

  • Returns true if this config is using the global path, false otherwise.

    Returns boolean

keys

read

  • read(throwOnNotFound?, force?): Promise<P>

  • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

    Parameters

    • Optional throwOnNotFound: boolean = false

      Optionally indicate if a throw should occur on file read.

    • Optional force: boolean = false

      Optionally force the file to be read from disk even when already read within the process.

    Returns Promise<P>

readSync

  • readSync(throwOnNotFound?, force?): P

  • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

    Parameters

    • Optional throwOnNotFound: boolean = false

      Optionally indicate if a throw should occur on file read.

    • Optional force: boolean = false

      Optionally force the file to be read from disk even when already read within the process.

    Returns P

set

  • set<K>(key, value): void

  • Sets the value for the key in the config object. This will override the existing value. To do a partial update, use BaseConfigStore.update.

    Type Parameters

    • K extends string

    Parameters

    • key: K

      The key.

    • value: P[K]

      The value.

    Returns void

setContentsFromObject

stat

  • stat(): Promise<Stats>

  • Get the stats of the file. Returns the stats of the file.

    fs.stat

    Returns Promise<Stats>

statSync

toObject

unlink

  • unlink(): Promise<void>

  • Delete the config file if it exists.

    Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

    Returns Promise<void>

unlinkSync

  • unlinkSync(): void

  • Delete the config file if it exists.

    Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

    Returns void

unset

  • unset<K>(key): boolean

  • Returns true if an element in the config object existed and has been removed, or false if the element does not exist. BaseConfigStore.has will return false afterwards.

    Type Parameters

    • K extends string

    Parameters

    • key: K

      The key

    Returns boolean

unsetAll

  • unsetAll(keys): 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). BaseConfigStore.has(key) will return false afterwards.

    Parameters

    • keys: Extract<keyof P, string>[]

      The keys

    Returns boolean

update

  • update<K>(key, value): void

  • Updates the value for the key in the config object. If the value is an object, it will be merged with the existing object.

    Type Parameters

    • K extends string

    Parameters

    • key: K

      The key.

    • value: Partial<P[K]>

      The value.

    Returns void

values

write

writeSync

Static getDefaultOptions

  • getDefaultOptions(isGlobal?, filename?): ConfigFile.Options

  • Returns the default options for the config file.

    Parameters

    • isGlobal: boolean = false

      If the file should be stored globally or locally.

    • Optional filename: string

      The name of the config file.

    Returns ConfigFile.Options

Static getFileName

Static resolveRootFolder

  • resolveRootFolder(isGlobal): Promise<string>

  • Helper used to determine 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 resolveRootFolderSync

  • resolveRootFolderSync(isGlobal): string

  • Helper used to determine 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 string

Settings

Member Visibility

Theme

On This Page

accessaccessSyncclearentriesexistsexistsSyncforEachgetgetContentsgetKeysByValuegetPathhasisGlobalkeysreadreadSyncsetsetContentsFromObjectstatstatSynctoObjectunlinkunlinkSyncunsetunsetAllupdatevalueswritewriteSyncgetDefaultOptionsgetFileNameresolveRootFolderresolveRootFolderSync