xerdi:local-storage

v0.0.6Published 3 years ago

This package has not had recent updates. Please investigate it's current state before committing to using it in your project.

Meteor Local Storage

Local Storage helpers for Meteor with ReactiveVar and ReactiveDict.

Installation

Add the package to your project:

meteor add xerdi:local-storage

Usage

The package exports three classes which can be used similarly.

import {LocalStorage, LocalVarStorage, LocalDictStorage} from 'xerdi:local-storage';

const defaults = {
    a: true,
    b: 5,
    c: 'text'
};

export const mySettings = new LocalDictStorage('mySettings', defaults);

API

Both LocalVarStorage and LocalDictStorage extend from LocalStorage.

LocalStorage

  • constructor Takes a storage key and an object with default values.
  • get() Gets the stored values.
  • set(keyOrObject, value) Either gets an object for setting all values or a key and value to set.
  • unset(key) Only works for LocalDictStorage and removes the given key from the dictionary.
  • setDefault() Sets all values to their default value.
  • clear() Wipes the stored data.