Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 2.99 KB

README.md

File metadata and controls

86 lines (56 loc) · 2.99 KB
Raw

ampersand-sync-localforage

Build Status NPM version

localForage sync adapter for Ampersand.js

This module overrides the sync method of your Ampersand models and collections to use localForage, a library that provides a unified API for accessing multiple browser storage options (IndexedDB, WebSQL, localStorage). localForage will use the best available option by default.

WARNING: This project is feature complete for our current needs. But if you encounter some rough edges or missing functionality feel free to file an issue or submit a pull request, to help make this library the best it can be!

Installation

npm install --save ampersand-sync-localforage

Usage

Just override the sync method on your models and collections with the function returned from the module.

Models

Pass a string to the function. This string serves as a namespace that is prefixed to the model’s storage key.

var Model = require('ampersand-model');
var localforage = require('ampersand-sync-localforage');

module.exports = Model.extend({
  sync: localforage('MyModelNamespace'),
  props: {
    id: 'string'
  }
});

Collections

Pass a string to use as the collection’s unique storage key.

var Collection = require('ampersand-rest-collection');
var localforage = require('ampersand-sync-localforage');
var MyModel = require('./my-model');

module.exports = Collection.extend({
  model: MyModel,  // Must also be set up with localForage
  sync: localforage('MyCollection'),
  props: {
    id: 'string'
  }
});

Under the hood, a collection is stored as a list of model IDs. Each model has its own entry in whatever storage option is being used.

Development

You’ll need Node.js and Grunt.

This project uses Karma to run the tests. In watch mode it launches Firefox, Chrome, and PhantomJS. In single-run mode it launches PhantomJS only.

To watch files for changes and run JSHint and Karma automatically during development, use

grunt dev

To run the linting and tests once, use

grunt

Credits

This project started as a port of localForage Backbone. It also draws inspiration from ConneXNL's port of Backbone.localStorage. Of course, many thanks go to the Ampersand.js team, as well as the developers at Mozilla who provide the localForage library.

License

Copyright (c) 2022 Neofonie

Licensed under the MIT license.