https://github.com/frozeman/meteor-persistent-minimongo

Local persistence for Meteor collections.
https://github.com/frozeman/meteor-persistent-minimongo

Last synced: 1 day ago
JSON representation

Local persistence for Meteor collections.

• Host: GitHub
• URL: https://github.com/frozeman/meteor-persistent-minimongo
• Owner: frozeman
• License: other
• Fork: true (jeffmitchel/meteor-local-persist)
• Created: 2015-01-21T10:57:59.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-03-12T14:47:19.000Z (over 2 years ago)
• Last Synced: 2024-08-02T05:09:55.036Z (3 months ago)
• Language: JavaScript
• Size: 117 KB
• Stars: 29
• Watchers: 5
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

README

        
# Meteor persistent minimongo

Simple client-side observer class that provides persistence for Meteor Collections using browser storage via Amplify.js. Collections are reactive across browser tabs.

*based on a package by Jeff Mitchel https://github.com/jeffmitchel/meteor-local-persist*

## Note

This package is using `localstorage` to persist your collections,

if you want to use the browsers indexedDB or webSQL use the new [frozeman:persistent-minimongo2](https://atmospherejs.com/frozeman/persistent-minimongo2) package!

## Installation:

`$ meteor add frozeman:persistent-minimongo`

## Documentation:

### Constructor:

```

new PersistentMinimongo(collection);

```

Collection is the Meteor Collection to be persisted.

### Methods:

```js

var myPersistentColleciton = new PersistentMinimongo(collection);

// Refreshes the collections from localstorage

myPersistentColleciton.refresh()

// Gets the current size of the localstorage in MB

myPersistentColleciton.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.

myPersistentColleciton.capCollection()

```

## Example:

Implement a simple shopping cart as a local collection.

```js

if (Meteor.isClient) {

    // create a local collection, 

    var shoppingCart = new Meteor.Collection('shopping-cart', {connection: null});

    // create a local persistence observer

    var shoppingCartObserver = new PersistentMinimongo(shoppingCart);

    // create a handlebars helper to fetch the data

    Handlebars.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 });

  });

}

```

```html

  Shopping Cart

  {{> shoppingCart}}

  

    

      Item

      Description

      Quantity

    

    {{#each shoppingCartItems}}

      

        {{item}}

        {{desc}}

        {{quantity}}

      

    {{/each}}

  

```

## Notes:

- 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.

- The cross-tab reactvity implementation is naive and will resync all PersistentMinimongo instances when a browser storage event is fired.

- See http://amplifyjs.com/api/store/#storagetypes for information about how data is stored in the browser.