$.store is a simple, yet easily extensible, plugin to persistently store data on the client side of things. It uses window.localStore where available. Older Internet Explorers will use userData. If all fails $.store will save your data to window.name.
+'$.store' is a simple, yet easily extensible, plugin to persistently store data on the client side of things. It uses 'window.localStore' where available. Older Internet Explorers will use 'userData'. If all fails '$.store' will save your data to 'window.name'.
-*Note*: The windowName will only do JSON serialization. windowName is not persistent in the sense of making it accross a closed browser window. If you need that ability you should check $.storage.driver.scope == "browser".
+*Note*: The 'windowName' driver will only do JSON serialization. 'windowName' is not persistent in the sense of making it across a closed browser window. If you need that ability you should check '$.storage.driver.scope == "browser"'.
## Usage ##
-
-//initialize
-$.storage = new $.store();
+ //initialize
+ $.storage = new $.store();
+
+ // save a value
+ $.storage.set( key, value );
+
+ // read a value
+ $.storage.get( key );
+
+ // deletes a value
+ $.storage.del( key );
+
+ // delete all values
+ $.storage.flush();
-// save a value
-$.storage.set( key, value );
+ // get the number of stored entries
+ $.storage.length();
+
+ // get a key by index (order is not guaranteed, use for iterating through keys)
+ $.storage.key( index );
+
+## Adding Serializers ##
-// read a value
-$.storage.get( key );
+You can easily add your own serializers to the stack. Make sure to add them before initializing the '$.store'.
-// deletes a value
-$.storage.del( key );
+*Note:* Serializers do not apply to the 'windowName' storage driver.
-// delete all values
-$.storage.flush();
-Initialized $.storage with driver ' + $.storage.driver.ident + '
' ); -
- $.store is a simple, yet easily extensible, plugin to persistently store data on the client side of things.
- It uses window.localStore where available. Older Internet Explorers will use userData.
- If all fails $.store will save your data to window.name.
-
- Note: The windowName will only do JSON serialization. windowName
- is not persistent in the sense of making it accross a closed browser window. If you need
- that ability you should check $.storage.driver.scope == "browser".
-
//initialize ++ +$.store jQuery plugin
+ ++ +
$.storeis a simple, yet easily extensible, plugin to persistently store data on the client side of things. It useswindow.localStorewhere available. Older Internet Explorers will useuserData. If all fails$.storewill save your data towindow.name.The optional
+ +cookiedriver requires the$.cookieplugin.Note: The
+ +windowNamedriver will only do JSON serialization.windowNameis not persistent in the sense of making it across a closed browser window. If you need that ability you should check$.storage.driver.scope == "browser".Usage
+ +- -//initialize $.storage = new $.store(); // save a value @@ -89,16 +83,16 @@Usage
$.storage.del( key ); // delete all values -$.storage.flush();Adding Serializers
- -- You can easily add your own serializers to the stack. - Make sure to add them before initializing the
-$.store. - Note: Serializers do not apply to thewindowNamestorage driver. -$.store.serializers.yaddayadda = { +$.storage.flush(); ++ +Adding Serializers
+ +You can easily add your own serializers to the stack. Make sure to add them before initializing the
+ +$.store.Note: Serializers do not apply to the
+ +windowNamestorage driver.+}; +$.store.serializers.yaddayadda = { ident: "$.store.serializers.yaddayadda", init: function( encoders, decoders ) { @@ -139,8 +133,12 @@Adding Serializers
return this.isYaddaYadda( value.value ) ? value.value : undefined; } -};
$.store is published under the MIT license.