electron-store

What is electron-store?

The electron-store npm package is a simple and efficient way to manage persistent user data in Electron applications. It provides a straightforward API for reading and writing JSON data, making it easy to store settings, preferences, and other types of data.

What are electron-store's main functionalities?

Basic Usage

This feature allows you to set, get, and delete key-value pairs in the store. It's useful for storing simple settings or preferences.

const Store = require('electron-store');
const store = new Store();

// Set a value
store.set('unicorn', '🦄');

// Get a value
console.log(store.get('unicorn'));
//=> '🦄'

// Delete a value
store.delete('unicorn');

Default Values

You can define default values for your store. These values will be used if no other value is set for the given key.

const Store = require('electron-store');
const store = new Store({
  defaults: {
    foo: 'bar'
  }
});

console.log(store.get('foo'));
//=> 'bar'

Schema Validation

You can define a schema to validate the data being stored. This ensures that the data conforms to the expected format and constraints.

const Store = require('electron-store');
const store = new Store({
  schema: {
    foo: {
      type: 'string',
      maxLength: 10,
      default: 'bar'
    }
  }
});

store.set('foo', 'baz');
console.log(store.get('foo'));
//=> 'baz'

Encryption

You can encrypt the data stored in the store by providing an encryption key. This adds a layer of security to sensitive data.

const Store = require('electron-store');
const store = new Store({
  encryptionKey: 'mySecretEncryptionKey'
});

store.set('unicorn', '🦄');
console.log(store.get('unicorn'));
//=> '🦄'

Other packages similar to electron-store

conf

The 'conf' package is similar to electron-store in that it provides a simple way to manage configuration data. It supports schema validation, encryption, and default values. However, it is not specifically designed for Electron and can be used in any Node.js application.

lowdb

The 'lowdb' package is a small local JSON database for Node.js. It provides a simple API for reading and writing JSON data, similar to electron-store. However, it is more flexible and can be used for more complex data structures and queries.

node-persist

The 'node-persist' package is a simple, zero-dependency, key-value storage library for Node.js. It provides similar functionality to electron-store, including support for JSON data and encryption. However, it does not include schema validation or default values.

README

electron-store