electron-config

Simple config handling for your Electron app or module

Electron doesn't have a built-in way to persist user settings and other data. This module handles that for you, so you can focus on building your app. Config is saved in a JSON file in app.getPath('userData').

You can use this module directly in both the main and renderer process.

Install

$ npm install --save electron-config

Usage

1const Config = require('electron-config');
2const config = new Config();
3
4config.set('unicorn', '🦄');
5console.log(config.get('unicorn'));
6//=> '🦄'
7
8// use dot-notation to access nested properties
9config.set('foo.bar', true);
10console.log(config.get('foo'));
11//=> {bar: true}
12
13config.delete('unicorn');
14console.log(config.get('unicorn'));
15//=> undefined

API

Config([options])

Returns a new instance.

options

defaults

Type: Object

Default config.

name

Type: string
Default: config

Name of the config file (without extension).

This is useful if you want multiple config files for your app. Or if you're making a reusable Electron module that persists some config, in which case you should not use the name config.

Instance

You can use dot-notation in a key to access nested properties.

The instance is iterable so you can use it directly in a for…of loop.

.set(key, value)

Set an item.

.set(object)

Set multiple items at once.

.get(key, [defaultValue])

Get an item or defaultValue if the item does not exist.

.has(key)

Check if an item exists.

.delete(key)

Delete an item.

.clear()

Delete all items.

.size

Get the item count.

.store

Get all the config as an object or replace the current config with an object:

1conf.store = {
2	hello: 'world'
3};

.path

Get the path to the config file.

Related

• electron-debug - Adds useful debug features to your Electron app
• electron-context-menu - Context menu for your Electron app
• electron-dl - Simplified file downloads for your Electron app
• conf - Simple config handling for your app or module

License

MIT © Sindre Sorhus