pref

Simple preference handling for your electron application

This is heavily inspired by and an extension of @sindresorhus's conf and electron-store projects. Shout out to him for creating these spectacular packages.

Install

❯ yarn add pref

Usage

const Pref = require('pref');
const preferences = new Pref();

preferences.set('spaceInvader', '👾');
console.log(preferences.get('spaceInvader'));
//=> '👾'

// Use dot-notation to access nested properties
preferences.set('foo.bar', true);
console.log(preferences.get('foo'));
//=> {bar: true}

preferences.delete('spaceInvader');
console.log(preferences.get('spaceInvader'));
//=> undefined

API

Changes are written to disk atomically, so if the process crashes during a write, it will not corrupt the existing config.

Pref([options])

Returns a new instance.

options

defaults

Type: Object

Default config.

configName

Type: string Default: config

Name of the config file (without extension).

Useful if you need multiple config files for your app or module. For example, different config files between two major versions.

projectName

Type: string Default: The name field in the package.json closest to where pref is imported.

You only need to specify this if you don't have a package.json file in your project.

projectVersion

Type: string Default: The version field in the package.json closest to where pref is imported.

You only need to specify this if you don't have a package.json file in your project and if you are using migrations.

cwd

Type: string Default: System default user config directory

You most likely don't need this. Please don't use it unless you really have to.

Overrides projectName.

The only use-case I can think of is having the config located in the app directory or on some external storage.

fileExtension

type: string Default: json

Extension of the config file.

You would usually not need this, but could be useful if you want to interact with a file with a custom file extension that can be associated with your app. These might be simple save/export/preference files that are intended to be shareable or saved outside of the app.

schema

type: object Default: undefined

JSON schema definition of store.

You can pass in a valid JSON schema and use it to coerce and validate your store. By default if a schema is passed in, it will coerce and add the defaults listed in the schema and coerce the values when you get them.

watch

type: boolean Default: true

Sets a file watcher.

This is useful if you have more than one window reading the preferences. If one window changes a preference, this allows it to get propagated to all instances of Pref. If only ever have one instance on Pref in your app you can turn this off.

migrations

type: object Default: undefined

Migrations to be run between versions.

Useful for transitioning preference changes between application versions. Ex:

// version is set to 0.0.1, the current app version is 2.0.8, 'old' key is set to 1
const store = new Store({
  migrations: {
    '0.0.0': store => {
      store.set('bad key', 2);
    },
    '1.0.0': store => {
      const old = store.get('old');
      store.set('new', old);
      store.delete('old');
    },
    '1.0.2': store => {
      store.set('a new key', 't');
    }
  }
})
store.store
=> { version: '2.0.8', new: 1, 'a new key': 't' }

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.

The value must be JSON serializable.

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

.onDidChange(key, callback)

callback: (newValue, oldValue) => {}

Watches the given key, calling callback on any changes. When a key is first set oldValue will be undefined, and when a key is deleted newValue will be undefined.

.size

Get the item count.

.store

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

pref.store = {
  hello: 'world'
};

.path

Get the path to the config file.

.isValid()

Validates the store against the passed in JSON schema. Returns a boolean.

License

MIT © Nick Pezza