Determines if the config file is read/write accessible.
The permission.
true if the user has capabilities specified by perm.
Asynchronously invokes actionFn once for each key-value pair present in the config object.
The function (key: string, value: ConfigValue) => Promise<void> to be called for each element.
Removes all key/value pairs from the config object.
Returns an array of ConfigEntry for each element in the config.
Check to see if the config file exists.
True if the config file exists and has access, false otherwise.
Invokes actionFn once for each key-value pair present in the config object.
The function (key: string, value: ConfigValue) => void to be called for each element.
Returns the value associated to the key, or undefined if there is none.
The key.
Returns the entire config contents.
Returns the list of keys that contain a value.
The value to filter keys on.
Returns the path to the config file.
Returns a boolean asserting whether a value has been associated to the key in the config object or not.
The key.
Used to initialize asynchronous components.
Returns true if this config is using the global path, false otherwise.
Returns an array that contains the keys for each element in the config object.
Read the config file and set the config contents.
The config contents of the config file.
Sets the value for the key in the config object.
The Key.
The value.
Returns the config object.
Sets the entire config contents.
The contents.
Convert an object to a ConfigContents and set it as the config contents.
The object.
Get the stats of the file.
The stats of the file.
Convert the config object to a JSON object.
Returns the config contents. Same as calling ConfigStore.getContents
Delete the config file if it exists.
True if the file was deleted, false otherwise.
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(key)} will return false afterwards.
The key.
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.
The keys.
Returns an array that contains the values for each element in the config object.
Write the config file with new contents. If no new contents are passed in it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.
The written contents.
Asynchronously constructs and initializes a new instance of a concrete subclass with the provided options.
An options object providing initialization params to the async constructor.
Returns the default options for the config file.
If the file should be stored globally or locally.
The name of the config file.
Returns the config's filename.
Helper used to determined what the local and global folder point to.
True if the config should be global. False for local.
The file path of the root folder.
Creates the config instance and reads the contents of the existing file, if there is one.
This is the same as
const myConfig = await MyConfig.create<MyConfig>();
await myConfig.read();Note: Cast to the extended class. e.g. await MyConfig.retrieve<MyConfig>();
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.
BaseConfigStore
class MyConfig extents ConfigFile { public static getFileName(): string { return 'myConfigFilename.json'; } } const myConfig = await MyConfig.create();
myConfig.set('mykey', 'myvalue');
await myconfig.write();