*
* @class mw.SafeStorage
* @private
- */
-
- /**
- * @ignore
* @param {Object|undefined} store The Storage instance to wrap around
*/
function SafeStorage( store ) {
* Retrieve value from device storage.
*
* @param {string} key Key of item to retrieve
- * @return {string|boolean} False when localStorage not available, otherwise string
+ * @return {string|null|boolean} String value, null if no value exists, or false
+ * if localStorage is not available.
*/
SafeStorage.prototype.get = function ( key ) {
try {
};
/**
- * Set a value in device storage.
- *
- * @param {string} key Key name to store under
- * @param {string} value Value to be stored
- * @return {boolean} Whether the save succeeded or not
- */
+ * Set a value in device storage.
+ *
+ * @param {string} key Key name to store under
+ * @param {string} value Value to be stored
+ * @return {boolean} Whether the save succeeded or not
+ */
SafeStorage.prototype.set = function ( key, value ) {
try {
this.store.setItem( key, value );
};
/**
- * Remove a value from device storage.
- *
- * @param {string} key Key of item to remove
- * @return {boolean} Whether the save succeeded or not
- */
+ * Remove a value from device storage.
+ *
+ * @param {string} key Key of item to remove
+ * @return {boolean} Whether the save succeeded or not
+ */
SafeStorage.prototype.remove = function ( key ) {
try {
this.store.removeItem( key );
};
/**
+ * A wrapper for the HTML5 `localStorage` interface
+ * that is safe to call on all browsers.
+ *
* @class
* @singleton
* @extends mw.SafeStorage
mw.storage = new SafeStorage( localStorage );
/**
+ * A wrapper for the HTML5 `sessionStorage` interface
+ * that is safe to call on all browsers.
+ *
* @class
* @singleton
* @extends mw.SafeStorage