backbone-localstorage-sync

Backbone LocalStorage sync adaptor

A Backbone sync function adapter for persisting Models and Collections to browser LocalStorage.

Based on example in Backbone Fundamentals book.

Modifications:

• Converted to a Node compatible module for use by Browserify/Webpack.
• No dependencies (Backbone or Underscore).
• The adapter sync to be used on a per Model and per Collection basis.

Installing

Install module with npm install backbone-localstorage-sync

Using

Globally, for example:

var BackboneLocalStorageSync = require('backbone-localstorage-sync.js');
Backbone.sync = BackboneLocalStorageSync('flux-backbone-todo');

On a per Model/Collection class basis, for example:

var BackboneLocalStorageSync = require('backbone-localstorage-sync.js');

var TodoItem = Backbone.Model.extend({
  sync: BackboneLocalStorageSync('flux-backbone-todo'),
});

var TodoStore = Backbone.Collection.extend({
  model: TodoItem,
  sync: BackboneLocalStorageSync('flux-backbone-todo'),
});

These examples assume you are bundling your app with a CommonJS comaptible tool such as Webpack or Browserify.

NOTE: Because LocalStorage requests execute synchronously the fetch, save and destroy APIs are also synchronous (differs from the usual async behavior of client-server adapters).