Class OrgUsersConfig

Determines if the config file is read/write accessible. Returns true if the user has capabilities specified by perm.

Determines if the config file is read/write accessible. Returns true if the user has capabilities specified by perm.

Asynchronously invokes actionFn once for each key-value pair present in the config object.

Returns

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. Returns true if the config file exists and has access, false otherwise.

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

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

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

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.

Returns the list of keys that contain a value.

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 a boolean asserting whether a value has been associated to the key in the config object or not.

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. 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.

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.

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

Sets the entire config contents.

Convert an object to a ConfigContents and set it as the config contents.

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

fs.stat

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

fs.stat

Convert the config object to a JSON object. Returns the config contents. Same as calling ConfigStore.getContents

Delete the config file if it exists.

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

Delete the config file if it exists.

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

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.

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.

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

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 provided it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.

Write the config file with new contents. If no new contents are provided it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.

Returns the default options for the config file.

Returns the config's filename.

Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

Helper used to determine what the local and global folder point to. Returns the file path of the root folder.