ff-db-liba

This package enables you to work with your local database as a JSON file. Your local file would act as a database in order to prevent data loss during npm manipulations.

Installation

First and foremost run following command to install

npm install ff-db-liba

Sample Use Cases

1import { FlatFileDb } from 'ff-db-liba';
2
3// give ralative path for your file
4const inputPath = path.join(__dirname, '/data.json');
5
6const flatfileDb = new FlatFileDb(inputPath);
7
8const records = flatfileDb
9  .getAllRecords()
10  .then((records) => console.log('Retrieved records: ', records));

Snippet above would log content of your local JSON database. Alternatively if it is needed to retrieve specific record run

1const id = '1';
2const records = flatfileDb
3  .getRecordById(id)
4  .then((record) => console.log(`Retrieved record with id ${id}`, record));

When initializing new database ypu should create a file with .json extension.

Make sure the content in your local data.json is initialized as follows

[]

To create a record use createRecord method described below.

1import { Record } from 'ff-db-liba';
2
3const data: Record<Object> = {
4  id: '2',
5  data: {
6    id: '2',
7    title: 'Some Title',
8  },
9  toJSON() {
10    return this.data;
11  },
12};
13
14const createRecord = flatfileDb
15  .createRecord(data)
16  .then((record) => console.log('New record created: ', record));

Afterwards your data.json would look like this:

[{"id":"2","title":"Some Title"}]

In order to update your specific record you should pass id as a string as well as all data parameters for an updated record.

1const id = '4';
2const updatedRecord = flatfileDb
3  .updateRecord(id, data)
4  .then((record) => console.log(`Updated record at id ${id}`, record));

To delete specific record u should pass id parameter only

1const id = '3';
2const deletedRecord = flatfileDb
3  .deleteRecord(id)
4  .then(() => console.log(`Deleted record with id ${id}`));