appstoragejs
v1.0.4
Published
LocalStorage for Node.js, auto syncing for objects with JSON files using the Proxy API
Downloads
14
Maintainers
Readme
AppStorage
LocalStorage for Node.js, auto syncing for objects with JSON files using the Proxy API
Table of Contents
Installation
npm install --save appstoragejs
Introduction
Use the ES6 Proxy API to set traps to recursively watch changes on an object and sync it automatically with a JSON
file within the current event loop phase using fs.writeFileSync
.
Good for
CLI tools, storing configs, user preferences, cached data, states, etc.Bad for
production applications, scalable or high-performance applications, web servers, etc.
Usage
- The data are synced automatically with
data.json
on every change within the current event loop phase. - The data are read automatically from
data.json
when the app starts. - Nothing to worry about just deal with the object as any normal object.
var AppStorage = require('appstoragejs');
// Create a new AppStorage
var appStorage = new AppStorage('data.json');
// Just do anything with your object !
appStorage.name = 'Bob';
appStorage.age = 13;
appStorage.records = [1,2,3,4];
You can define your AppStorage object as a global
object to be used anywhere within your app.
global.appStorage = appStorage;
License
This project is under the MIT license.