Skip to content
Simple wrapper for JavaScript localStorage
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
tests
.gitignore
.vhosts
CONTRIBUTING.md
Makefile
Makefile.js
README.md
angular.keyStorage.js
angular.keyStorage.min.js
bower.json
keyStorage.js
keyStorage.min.js
package.json

README.md

localStorage.keyDB.js

Examples

Simple localStorage

ls = new Storage();

if (!ls.test()) {
    alert('Your browser seems to be in Private Mode. Please disable it if you\'d like your settings saved for your next visit.');
}

ls.get('key');
ls.get('key', {}); // set passed in param if get is null
ls.set('key', {});
ls.remove('key');
ls.clear();

// sessionStorage
ss = new Storage('sessionStorage');

Creating a keyDB

ls.key_name = new keyStorage(
    "name",// prefix for all keys
    { // default object (optional)
        "key":"",
        "value":"",
        "timestamp":Date.now()
    }
);
ls.key_name.get('key');
ls.key_name.getAllArray('key', []);
ls.key_name.getAllArray('key', function() {return [];});
ls.key_name.set('key', {});
ls.key_name.remove('key');
ls.key_name.clear();

var list = ls.key_name.keys;    // get list of keys
var obj = ls.key_name.obj;  // get default obj

Important Notes

  • JSON.parse() and JSON.stringify() are built-in for when objects or arrays are passed in.
  • "keys" is a reserved key name for keyStorage objects.
Something went wrong with that request. Please try again.