secure-json/README.md

JSON storage library to securely persist json data on disk

![Secure-JSON Icon](https://raw.githubusercontent.com/HydroCarbons/secure-json/master/secure-json-256.png)

## Travis CI Status
[![Build Status](https://travis-ci.com/HydroCarbons/secure-json.svg?branch=master)](https://travis-ci.com/HydroCarbons/secure-json)

# Secure JSON
- **Secure JSON** JSON storage library to securely persist JSON data on disk. **Cipher** is configured to use **AES-256-CBC** with initialization vector.
- There are two types of storage schema: _inmemory_ or _disk_
  - **inmemory**: Store items are not persisted on disk and are not encrypted.
  - **disk**: Store items are persisted on disk and can be encrypted.

## Usage

### Install
```javascript
npm install secure-json --save
```

### Require
```javascript
const SecureJStore = require("secure-json");
```
### Create an instance of SecureJStore
```javascript
var instance = new SecureJStore();
```

### Initialize instance with options
```javascript

var options = {
    store: <Path to SecureJStore directory>,
    dbType: <Specify "inmemory" or "disk">,
    password: <Specify password to encrypt the SecureJStore>
  };

instance.init(options);
```

### Create an instance of SecureJStore
```javascript
var instance = new SecureJStore();
```

### Storing an item
```javascript
instance.setItem("key1", "value1");
```

### Retrieving an item
```javascript
let value = instance.getItem("key1");
```

### Removing an item
```javascript
let value = instance.removeItem("key1");
```

### Retrieving all keys
```javascript
let keys = instance.keys();
```

### Retrieving all values
```javascript
let values = instance.values();
```

### Retrieving all entries of (key, value) pairs
```javascript
let items = instance.entries();
```

### Retrieving all entries with for...of loop
```javascript
for(let item of instance ) { ... }
```

### Retrieving all entries with forEach loop
```javascript
instance.forEach( (x) => { ... });
```

### Archiving instance
```javascript
instance.archive();
```

## Library Usage/Test
### Install
` npm install `

### Test
` npm run test `

### Coverage
` npm run coverage`

OR

` istanbul cover ./test/test.js `

Check coverage folder