JSON records

Description

Simple JSON records DB with locally saved file.

Installation

npm install json-records --save

Initialization

// Import.
const JsonRecords = require('json-records');

Using

// Define JSON records instance.
const jr = new JsonRecords('data.json');

// Add 2 records.
jr.add({ a: 1, c: 3 });
jr.add({ a: 4, c: 6 });

// Get all records.
const allRecords = jr.get();
// => Array allRecords: [ { a: 1, c: 3 }, { a: 4, c: 6 } ].

// Get filtered records.
const filteredRecords = jr.get(record => record.a === 1);
// => Array filteredRecords: [ { a: 1, c: 3 } ].

// Update records by filter.
jr.update(record => record.a === 1, { c: 8 });

// Remove records by filter.
jr.remove(record => record.a === 1);

// Remove all records.
jr.remove();

// You can also add data with bulk mode.
jr.addBulk([{ a: 1, c: 3 }, { a: 4, c: 6 }]);

Using with custom init params

// Define JSON records instance with params:
// - Set async indicator as `true` and define saving timeout `500` ms.
// - Set logs indicator as `true` (show additional logs output).
const jr = new JsonRecords('data.json', {
  async: true,
  asyncTimeout: 500,
  logs: true
});

// And work with records...

License

The MIT License (MIT)

Copyright © 2017 - 2023 Volodymyr Sichka

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.