rstorage's Introduction

rStorage

jQuery rStorage Plugin

localStorage and sessionStorage helper utility for jQuery

rStorage simplify the usage of localStorage and sessionStorage with JSON objects.

If you have any idea about improving this plugin please let me know

Functionalities

Simple namespacing
Store objects and encoding, decoding to or from JSON happens automatically
Same function call for getters and setters
Setters and getters recognize dot notation format
Integrated unit tests

How to use

The API is the same for both storages.

Setter

var myObject = {
  level1 : {
     level2 : {
        level3 : 'level3'
     }
  }
}

$.localStorage('testNamespace', myObject);     //setter

//updating an existing key somewhere deep inside the object
$.localStorage(
    'testNamespace.level1.level2',
    {
        foo : {
            bar : 'Gauranga!'
        }
    });

//insert a new key deeply
$.localStorage(
    'testNamespace.aNew.deeply.foo',
    {
        bar : 'Gauranga!'
    });

Getter

$.localStorage('testNamespace');      //getter
$.localStorage('testNamespace.level1');      //dot notation getter

Removing parts by dot notation

$.localStorage.remove('testNamespace.level1.level2');

Same examples for sessionStorage

$.sessionStorage('testNamespace');     //getter, it does not see what we have in $.localStorage
$.sessionStorage('testNamespace',
    {
       book : {
          chapter1: {
             title : 'First Chapter',
             pages : 200
          }
          chapter2: {
             title : 'Second Chapter',
             pages : 300
          }
       }
    });

$.sessionStorage(
    'testNamespace.level1.level2',
    {
        foo : {
            bar : 'Gauranga!'
        }
    });

$.sessionStorage(
    'testNamespace.aNew.deeply.foo',
    {
        bar : 'Gauranga!'
    });


$.sessionStorage('testNamespace');    //getter will return our book object

rstorage's People

Contributors

Watchers

rstorage's Issues

add deep property

$.sessionStorage('testNamespace', {});
$.sessionStorage('testNamespace.otherKey.newProp', 'gaura');

key reject

Az alabbi problemaba futottam:

$.localStorage('user', userObj); // userObj egy json object
$.localStorage('user.akarmi', mezo); // az 'akarmi' kulcs nem letezik, ezert hibat dob

Ezt pl. ki tudom ugy kuszobolni, hogy:

var userObj = $.localStorage('user');
userObj.akarmi = mezo;
$.localStorage('user', userObj);

De ez egy kicsit korulmenyes. Szerinted lenne ertelme egy “append” funkcio hozzaadasanak a plugin-hez? Azaz, ha egy mar letezo object-hez szeretnek egy uj tulajdonsagot hozzafuzni, azt egyszerubben meg lehessen oldani (mint pl. a peldam masodik sora)?

Recommend Projects