Lowkie
Description
Lowkie is a lokijs object modeling tool designed to work in an asynchronous environment.
Installation
$ npm i lowkie
Full Documentation
Usage (basic)
//lowkie singletonconst lowkie = ; //connect to lowkie (includes loki connection configuration), options can include other loki adapters besides structured file adapterslowkie ; //listen for connection errorslowkieconnection; //listen for connecting status, dbname is the path to the db json filelowkieconnection; //once connected, create models, query the db, etclowkieconnection;
Development
Make sure you have grunt installed
$ npm i -g grunt-cli jsdoc-to-markdown
For generating documentation
$ grunt doc$ jsdoc2md lib/**/*.js index.js > doc/api.md
Notes
- Check out https://github.com/typesettin/lowkie for the full Lowkie Documentation
Testing
$ npm i$ grunt test
Contributing
fork and create a pull request!
License
MIT