js-data-asyncstorage v0.1.0

js-data-asyncstorage

js-data is a very sophisticated data handling library. I'am currently developing for react-native and wanted to unleash the power of js-data on react-native, so I built this adapter which uses react-native's AsyncStorage class, instead of a browsers localstorage.

Disclaimer: This is the first version of this adapter. Although the tests are passing there may be still some bugs hidden somewhere. If you find any, I'd love to hear from you.

API Documentation

DSAsyncStorageAdapter

Project Status

Latest Release:

Quick Start

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

Load js-data-asyncstorage.js after js-data.js.

var adapter = new DSAsyncStorageAdapter();

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

// "store" will now use the asyncstorage adapter for all operations

Changelog

CHANGELOG.md

Community

• Mailing List - Ask your questions!
• Issues - Found a bug? Feature request? Submit an issue!
• GitHub - View the source code for js-data.
• Contributing Guide

Features

• Add better testing (tests are currently executed in chrome, because I don't know of an easy way to test in react-native. )
• Create an example app of how to use js-data with react-native.
• ...

Contributing Guide

If you have any questions regarding this adapter, feel free to open an issue or write me an email.

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

• good - Your versions of Angular, JSData, 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.

Pull Requests

1. Contribute to the issue that is the reason you'll be developing in the first place
2. Fork js-data-asyncstorage
3. git clone https://github.com/<you>/js-data-asyncstorage.git
4. cd js-data-asyncstorage; npm install; bower install;
5. You need to follow the instructions in src/index.js to be able to run the tests without react-native.
6. grunt go (builds and starts a watch)
7. (in another terminal) grunt karma:dev (runs the tests)
8. Write your code, including relevant documentation and tests
9. Submit a PR and we'll review

License

This adapter is mainly based on the work of Jason Dobry for the js-data-localstorage adapter.

The MIT License (MIT)

Copyright (c) 2015 Lukas Reichart & 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.