⚡ A simple, powerful, and useful JSON database, similar to Map but with over 50+ methods and features, and the data is saved in a specific .json file.

- Beginner-Friendly.
- Simple, free, and easy to use.
- Helpful guide by using IntelliSense and in declaration files.
- Built-in Math conditions (including strict mode).
- Customizable only allowed types for property values.
- 100% written in TypeScript.

Note: It is recommended to use TypeScript for the types. You can use JavaScript but it will not care about the types, which is going to cause many errors and problems in the future.

Table of Contents

- TFA-JSONMap
- Table of Contents
- Requirements
- Installation
- What's new?
- Load a module
- TypeScript
- JavaScript (CommonJS)
- Example usage
- Define a new database using JSONMap
- Type parameter using interface keyword
- Using simple methods
- Constructor options
- Type parameter
- Modules
- Class: JSONMap
- Enum: Events
- FAQs
- I am getting a SyntaxError, what should I do?
- What is prettier in the constructor options?
- How to pull an element from an array?
- Pull some specific elements
- Pull everything except specific elements
- License

Requirements

- Node.js version 16.0.0 or above.

Installation

Install the latest version:
``coffee
npm install tfa-jsonmap
`

Install the latest prerelease version:
`coffee
npm install tfa-jsonmap@prerelease
`

What's new?

- New methods: setJSON, lock, and unlock.
- New property: locked (boolean).

Load a module

$3

`ts
import { } from 'tfa-jsonmap';
`

$3

`js
const { } = require('tfa-jsonmap');
`

↑ Back to top

Example usage

$3

`ts
import { JSONMap } from 'tfa-jsonmap';

const db = new JSONMap('./path/to/your/json/file.json');
`

↑ Back to top

$3

`ts
interface User {
name: string,
age: number,
gender?: 'Male' | 'Female', // <= Optional property
hobbies: string[]
};

const db = new JSONMap('./path/to/your/json/file.json');

db.set('Micheal', {
name: 'Micheal',
age: 45,
hobbies: ['Football', 'Tennis']
});
`

↑ Back to top

$3

`ts
const db = new JSONMap('./path/to/your/json/file.json');

db.set('username', 'T.F.A');
db.set('balance', 69420);
db.set('langs', ['PY', 'TS']);

db.push('langs', 'Rust', 'JS'); // => langs: ['PY', 'TS', 'Rust', 'JS']
db.filter('langs', (item) => item !== 'Rust'); // => langs: ['PY', 'TS', 'JS']

db.has('balance'); // => true
db.delete('balance');
db.has('balance'); // => false

db.keys(); // => ['username', 'langs']
db.values(); // => ['T.F.A', ['PY', 'TS, 'JS']]

db.reverse();

db.keys(); // => ['langs', 'username']
db.values(); // => [['PY', 'TS, 'JS'], 'T.F.A']

db.keyIndex('langs'); // => 0
db.keyAt(1); // => 'username'

db.hasAll('username', 'langs'); // => true
db.hasAll('username', 'age', 'langs'); // => false

db.hasAny('username', 'langs'); // => true
db.hasAny('username', 'age', 'langs'); // => true

db.deleteMany('username', 'langs');

db.keys(); // => []

db.set('var1', 45);
db.set('var2', 45);
db.set('var3', '45');
db.set('var4', 60);

db.on('keyCreate', (key, value) => { });
db.on('keyDelete', (key) => { });

db.$equalTo('var1', 'var2'); // => true
db.$equalTo('var2', 'var3'); // => true
db.$strictEqualTo('var2', 'var3'); // => Error: TypeError

db.$lessThan('var4', 'var2'); // => false
db.$greaterThan('var4', 'var2'); // => true

db.$lessThanOrEqual('var1', 'var2'); // => true
db.$greaterThanOrEqual('var2', 'var4'); // => false

db.typeofKey('var3'); // => string
db.typeofKey('var1'); // => number

db.isRepeated(45); // => true
db.isRepeated(60); // => false

db.replace('var2', 'var4'); // => var4: 45

db.deleteMany('var2', 'var4');

db.map((K, V) => K: ${K}; V: ${V}); // => ['K: var1; V: 45', 'K: var3; V: 45']

db.clone('new-file.json')
.then((newdb) => newdb.toJSON()); // => { 'var1': 45, 'var3': '45' }

db.toJSON(); // => { 'var1': 45, 'var3': '45' }
`

↑ Back to top

Constructor options

| Option | Type | Required? | Default | Description |
| ------ | ----- | ----- | ----- | ----- |
| autoclear | boolean | No | false | Clear the data on startup? |
| prettier | boolean | No | false | Make the JSON file looks pretty? |

↑ Back to top

Type parameter

This only works for TypeScript. The types below are for keys' values. By default, it's any. This is also applies for the method JSONMap#clone().

``ts
new JSONMap(); // Only string is acceptable.
new JSONMap(); // Only number is acceptable.
new JSONMap(); // Only boolean is acceptable.
new JSONMap