Giter Club home page Giter Club logo

secure-json's Introduction

Secure-JSON Icon

Travis CI Status

Build Status Coverage Status

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

npm install secure-json --save

Require

const SecureJStore = require("secure-json");

Create an instance of SecureJStore

var instance = new SecureJStore();

Initialize instance with options

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

var instance = new SecureJStore();

Storing an item

instance.setItem("key1", "value1");

Retrieving an item

let value = instance.getItem("key1");

Removing an item

let value = instance.removeItem("key1");

Retrieving all keys

let keys = instance.keys();

Retrieving all values

let values = instance.values();

Retrieving all entries of (key, value) pairs

let items = instance.entries();

Retrieving all entries with for...of loop

for(let item of instance ) { ... }

Retrieving all entries with forEach loop

instance.forEach( (x) => { ... });

Archiving instance

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.