Save settings to a disk and load them in when your app starts. A user settings manager for Electron, adapted from Atom/config.
Requires Electron 0.35.0 or above.
new ElectronSettings([options])
Arguments
-
options(Object) - Custom options for thisElectronSettingsinstance.-
options.configDirPath(string) - Absolute path to the directory where you'd like to save your settings.json file. By default this is in your user data directory. Seeapp.getPath('userData'). -
options.configFileName(string) - The file name for your settings file. By default this issettings. Omit the.jsonextension. -
options.debouncedSaveTime(number) - The maximum amount of time in milliseconds that must elapse before saving to disk. Default100
-
Example
To use electron-settings, first import the class, then create a new electron-settings instance:
const ElectronSettings = require('electron-settings');
let settings = new ElectronSettings();
console.log(settings.getConfigFilePath());
// => /Users/Nathan/Library/Application Support/Electron/electron-settings/settings.jsonThis will automatically generate a settings.json file in your user data directory if one does not exist. If the file already exists, it will be imported.
MIT