Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 4.75 KB

README.md

File metadata and controls

102 lines (74 loc) · 4.75 KB
Raw

js-data logo

js-data-nedb npm version Circle CI npm downloads License

nedb adapter for js-data.

API Documentation

DSNedbAdapter

Project Status

Latest Release: Latest Release

Quick Start

npm install --save js-data js-data-nedb.

Load js-data-nedb.js after js-data.js.

var adapter = new DSNedbAdapter();

var store = new JSData.DS();
store.registerAdapter('nedb', adapter, { default: true });

// "store" will now use the nedb adapter for all async operations
var User = store.defineResource({
  name: 'user',
  // path where you want the table file for this resource created
  filepath: 'path/to/userTable.db'
});

// nedb handler is available here
User.db; // don't run custom queries unless you know what you're doing

// one method you might want to call is User.db.persistence.compactDatafile()

// we don't specify a filepath here,
// so it's automatically created at "./post.db"
var Post = store.defineResource({
  name: 'post'
});

Changelog

CHANGELOG.md

Community

Contributing

First, support is handled via the Gitter Channel and the Mailing List. Ask your questions there.

When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.

  • good - Your versions of js-data, js-data-nedb, etc., relevant console logs/error, code examples that revealed the issue
  • better - A plnkr, fiddle, or bin that demonstrates the issue
  • best - A Pull Request that fixes the issue, including test coverage for the issue and the fix

Github Issues.

Submitting Pull Requests

  1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
  2. Fork js-data-nedb
  3. git clone [email protected]:<you>/js-data-nedb.git
  4. cd js-data-nedb; npm install; bower install;
  5. Write your code, including relevant documentation and tests
  6. Run grunt test (build and test)
  7. Your code will be linted and checked for formatting, the tests will be run
  8. The dist/ folder & files will be generated, do NOT commit dist/*! They will be committed when a release is cut.
  9. Submit your PR and we'll review!
  10. Thanks!

License

The MIT License (MIT)

Copyright (c) 2014-2015 Jason Dobry

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.