Quite simply a localStorage adapter for Backbone. It's a drop-in replacement for Backbone.Sync() to handle saving to a localStorage database.
Include Backbone.localStorage after having included Backbone.js:
Create your collections like so:
windowSomeCollection = BackboneCollectionextendlocalStorage: "SomeCollection" // Unique name within your app.// ... everything else is normal.;
If needed, you can use the default
Backbone.sync (instead of local storage) by passing the
ajaxSync option flag to any Backbone AJAX function, for example:
var myModel = ;myModelfetch ajaxSync: true ;myModelsave new: "value" ajaxSync: true ;
requireconfigpaths:jquery: "lib/jquery"underscore: "lib/underscore"backbone: "lib/backbone"localstorage: "lib/backbone.localStorage";
Define your collection as a module:
define"SomeCollection" "localstorage"var SomeCollection = BackboneCollectionextendlocalStorage: "SomeCollection" // Unique name within your app.;return SomeCollection;;
Require your collection:
require"SomeCollection"// ready to use SomeCollection;
If you're using browserify.
npm install backbone.localstorage, and require the module.
BackboneLocalStorage = require"backbone.localstorage";
If you're having a problem with using the project, get help at CodersClan.
You'll need node and to
npm install before being able to run the minification script.
- Write code, with tests;
- Create a pull request.
Licensed under MIT license
Copyright (c) 2010 Jerome Gravel-Niquet
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.