js-data-localstorage

js-data-localstorage 3.0.0-alpha.1

js-data logo

js-data-localstorage

Slack Status npm version Circle CI npm downloads Coverage Status Codacy

localStorage adapter for js-data.

Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using bs logo

Table of contents

Quick Start

npm install --save js-data js-data-localstorage or bower install --save js-data js-data-localstorage.

Load js-data-localstorage.js after js-data.js.

var adapter = new LocalStorageAdapter();

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

// "store" will now use the localstorage adapter

You can also provide a custom storage medium (it just needs to implement the localStorage API):

var memory = {};

// Turn js-data-localstorage into an in-memory adapter
var memoryAdapter = new LocalStorageAdapter({
  storage: {
    getItem: function (key) {
      return memory[key];
    },
    setItem: function (key, value) {
      return memory[key] = value;
    },
    removeItem: function (key) {
      delete memory[key];
    }
  }
});

// Turn js-data-localstorage into a sessionStorage adapter
var sessionAdapter = new LocalStorageAdapter({
  storage: sessionStorage
});

Documentation

API Reference

Demo

https://js-data-localstorage.firebaseapp.com/

Support

Support questions are handled via StackOverflow, [Slack][slack], and the [Mailing List][ml]. Ask your questions there.

Community

Contributing

When submitting bug reports or feature requests on GitHub, please include as much detail as possible.

  • good - Your versions of Angular, JSData, etc, relevant console logs, stack traces, code examples that revealed the issue, etc.
  • 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

Pull Requests

  1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
  2. Fork js-data
  3. git clone git@github.com:<you>/js-data-localstorage.git
  4. cd js-data-localstorage; npm install;
  5. Write your code, including relevant documentation and tests
  6. Run npm 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-2016 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.