Skip to content

Latest commit

 

History

History
106 lines (75 loc) · 3.1 KB

README.md

File metadata and controls

106 lines (75 loc) · 3.1 KB
Raw

Meteor persistent minimongo

Simple client-side observer class that provides persistence for Meteor Collections using browser storage via localforage.

localforage uses the browsers indexedDB, if not available tries webSQL and as last option uses localstorage.

package based on meteor-local-persist by Jeff Mitchel

Notes

  • If you UPDATE from 1.x.x, be aware that you will loose your stored data, as its now stored in the browsers indexedDB if available.
  • The cross-tab reactvity is gone since version 2.0.0, as its not using localstorage anymore !!
  • This is a simple implementation that keeps an identical copy of the collection's data in browser storage. While not especially space efficient, it does preserve all of the Meteor.Collection reactive goodness.

Installation

$ meteor add frozeman:persistent-minimongo2

Documentation

Constructor

new PersistentMinimongo2(collection, 'myAppName');

collection is the Meteor Collection to be persisted.

The last parameter is the apps name and should be used to identifiy your persisted collections inside your storage. Default is minimongo

Methods:

var myPersistentCollection = new PersistentMinimongo2(collection, 'myAppName');

// Refreshes the collections from the storage
myPersistentCollection.refresh()

// If you ever need to clear you storage use
localforage.clear();

// The below is only interesting if your brower doesn't support indexedDB or webSQL:
// Gets the current size of the localstorage in MB
myPersistentCollection.localStorageSize()

// Will check if the current size of the localstorage is larger then 4.8 MB, if so it will remove the 50 latest entries of the collection.
myPersistentCollection.capCollection()

Example:

Implement a simple shopping cart as a local collection.

if (Meteor.isClient) {
    // create a local collection, 
    var shoppingCart = new Meteor.Collection('shopping-cart', {connection: null});

    // create a local persistence observer
    var shoppingCartObserver = new PersistentMinimongo2(shoppingCart, 'myShoppingApp');

    // create a handlebars helper to fetch the data
    Template.registerHelper("shoppingCartItems", function () {
      return shoppingCart.find();
    });

    // that's it. just use the collection normally and the observer
    // will keep it sync'd to browser storage. the data will be stored
    // back into the collection when returning to the app (depending,
    // of course, on availability of localStorage in the browser).

    shoppingCart.insert({ item: 'DMB-01', desc: 'Discover Meteor Book', quantity: 1 });
  });
}
<head>
  <title>Shopping Cart</title>
</head>

<body>
  {{> shoppingCart}}
</body>

<template name="shoppingCart">
  <table>
    <tr>
      <th>Item</th>
      <th>Description</th>
      <th>Quantity</th>
    </tr>
    {{#each shoppingCartItems}}
      <tr>
        <td>{{item}}</td>
        <td>{{desc}}</td>
        <td>{{quantity}}</td>
      </tr>
    {{/each}}
  </table>
</template>