lowdb-crypto-adapter

A lowdb adapter for encrypting data to be stored

Installation

npm install lowdb-crypto-adapter --save

Usage

const low = require('lowdb');
const CryptoAdapter = require('lowdb-crypto-adapter');

let adapter;
try {
  adapter = new CryptoAdapter('my.db', 'PASSWORD');
} catch(error) {
  console.log("Maybe wrong password?");
}

// and then you can use lowdb as usual, but now your data is secured

const db = low(adapter);

// Set some defaults (required if your JSON file is empty)
db.defaults({ posts: [], user: {}, count: 0 })
  .write()

// Add a post
db.get('posts')
  .push({ id: 1, title: 'lowdb is awesome'})
  .write()

API

new CryptoAdapter(file, password, [test])

Creates a new adapter for lowdb

Arguments

• file - (string) Path to the database file
• password - (string) Sekret key, that will be used to encrypt/decrypt data
• [test] - (boolen) If true, a connection to the database will be performed, and, if it will faled, an Error will be thrown. By default it is true

License

MIT