/sites/web/bower_components/localforage-backbone/README.md

https://bitbucket.org/aswinvk28/smartpan-stock-drupal · Markdown · 41 lines · 27 code · 14 blank · 0 comment · 0 complexity · 8e99a50070feffceea27330db246eef8 MD5 · raw file 

    

  1. # localForage Backbone [![Build Status](https://secure.travis-ci.org/mozilla/localForage-backbone.png?branch=master)](http://travis-ci.org/mozilla/localForage-backbone)
    2. 

  2. 

  3. Backbone.js driver for the
    4. 

  4. [localForage offline storage library](https://github.com/mozilla/localForage).
    5. 

  5. 

  6. Install with bower:
    7. 

  7. 

  8.     bower install localforage-backbone
    9. 

  9. 

  10. Run tests with grunt:
    11. 

  11. 

  12.     grunt test
    13. 

  13. 

  14. Submit issues, pull requests, etc. if something is up! <3
    15. 

  15. 

  16. ## Usage
    17. 

  17. 

  18. This library lets you override the `sync()` method on your collections and
    19. 

  19. models so they're saved to localForage instead of a REST server. Simply
    20. 

  20. override your objects' `sync()` method with the namespace for your model:
    21. 

    22. 

  22.     var MyModel = Backbone.Collection.extend({
    23. 

  23.         sync: Backbone.localforage.sync('MyModel')
    24. 

  24.     });
    25. 

  25.     var MyCollection = Backbone.Collection.extend({
    26. 

  26.         model: MyModel,
    27. 

  27.         sync: Backbone.localforage.sync('MyCollection')
    28. 

  28.     });
    29. 

  29. 

  30. Now whenever you save your collections or models, they'll be saved with
    31. 

  31. localForage!
    32. 

  32. 

  33. # License
    34. 

  34. 

  35. This program is free software; it is distributed under an
    36. 

  36. [Apache License](http://github.com/mozilla/localForage-backbone/blob/master/LICENSE).
    37. 

  37. 

  38. ---
    39. 

  39. 

  40. Copyright (c) 2014 [Mozilla](https://mozilla.org)
    41. 

  41. ([Contributors](https://github.com/mozilla/localForage-backbone/graphs/contributors)).
    42.