Enmap-JSON-Sync

This package allows you to use most of the normal JS Map functions but in the background automatically persists your data to a JSON file. I created this project because I just wanted a simple way to create key pair values and have them automatically save to a file without needing to download and setup a bunch of third party applications such an SQL db. This is perfect for small projects or projects that don't need to persist a lot of data.

npm i enmap-json-sync

Examples & Usages

Create an instance

1const EnJS = require('enmap-json-sync');
2const Scores = new EnJS('./settings.json');
3// Path to a JSON file
4
5(async function () {
6  await Scores.loadFromJSON();
7})();

Creating

1const EnJS = require('enmap-json-sync');
2const Scores = new EnJS('./settings.json');
3// Path to a JSON file
4
5(async function () {
6  await Scores.loadFromJSON();
7  // Random ID of a user
8  Scores.set('2342342343234234', { name: 'Brandon', score: 10 });
9})();

Deleting

1const EnJS = require('enmap-json-sync');
2const Scores = new EnJS('./settings.json');
3// Path to a JSON file
4
5(async function () {
6  await Scores.loadFromJSON();
7  Scores.delete('2342342343234234');
8})();

Updating

1const EnJS = require('enmap-json-sync');
2const Scores = new EnJS('./settings.json');
3// Path to a JSON file
4
5(async function () {
6  await Scores.loadFromJSON();
7  const currentScore = await Scores.get('2342342343234234').score;
8  data.update('2342342343234234', 'score', currentScore++);
9})();

Fetch All Keys

1const EnJS = require('enmap-json-sync');
2const Scores = new EnJS('./settings.json');
3// Path to a JSON file
4
5(async function () {
6  await Scores.loadFromJSON();
7  const scoreKeys = await Scores.keys();
8})();