📝 A simple persistent user settings framework for Electron.
Clone or download
Nathan Buchar
Nathan Buchar 3.2.0
Latest commit 55c41af May 17, 2018

README.md

electron-settings

Npm version Npm downloads David Travis Gitter

A simple persistent user settings framework for Electron.

Originally adapted from Atom's own configuration manager and the settings manager of choice for Electron's own demo app, electron-settings allows you to persist user settings and other data simply and easily.

Also, you can subscribe to properties and get notified when their values change. So that's pretty nifty.


Install

$ npm install --save electron-settings

Demo

const { app } = require('electron');
const settings = require('electron-settings');

app.on('ready', () => {

  settings.set('name', {
    first: 'Cosmo',
    last: 'Kramer'
  });

  settings.get('name.first');
  // => "Cosmo"

  settings.has('name.middle');
  // => false
});

⚠️ Please note: Any and all interaction with electron-settings must be executed after the Electron app has fired the ready event, otherwise your app may encounter unexpected errors or data loss.

Resources




Having trouble? Get help on Gitter.