electron-settings

Electron Settings

A simple and robust settings management library for Electron.

Born from Atom's original internal configuration manager and the settings manager of choice for Electron's own API Demos app, Electron Settings allows you to persist user settings and other data between app loads simply and easily.

Install

npm install electron-settings

Demo

import settings from 'electron-settings';

await settings.set('color', {
  name: 'cerulean',
  code: {
    rgb: [0, 179, 230],
    hex: '#003BE6'
  }
});

await settings.get('color.name');
// => "cerulean"

await settings.get('color.code.rgb[1]');
// => 179

electron-settings only works in the main process. If you want to use electron-settings in the renderer process, you need to use IPC.

// main process
ipcMain.handle('getSettingValue', (event, key) => {
  return settings.get(key);
});

// renderer-process
const foo = await ipcRenderer.invoke('getSettingValue', 'foo');

API Docs

API docs and can be found at electron-settings.js.org.

---

Having trouble? Get help on Gitter.