/**
* Facade to access the browser's localstorage and session storage
*
* @fileoverview Storage facade compatible with localStorage and sessionStorage
*
* @author Deux Huit Huit <https://deuxhuithuit.com>
* @license MIT <https://deuxhuithuit.mit-license.org>
*
* @namespace storage
* @memberof App
* @requires App
*/
(function ($, global, undefined) {
'use strict';
var storage = function (storage) {
return {
/**
* Return the value associated with the given key
* @name get
* @memberof storage
* @method
* @param {string} key Access key to the storage object
* @return {String}
* @public
*/
get: function (key) {
if (!key) {
return;
}
key += ''; // make it a string
return storage[key];
},
/**
* Set and save a value to the given key in the storage
* @name set
* @memberof storage
* @method
* @param {string} key Access key to the storage object
* @param {*} value Value wanted to be saved
* @return {Boolean}
* @public
*/
set: function (key, value) {
var result = false;
if (!!key) {
key += ''; // make it a string
try {
storage[key] = !value ? '' : value + '';
result = true;
} catch (e) {
App.log({
args: e.message,
me: 'Storage',
fx: 'error'
});
result = false;
}
}
return result;
},
/**
* Delete the storage data associated with the given key
* @name remove
* @memberof storage
* @method
* @param {string} key Access key to the storage object
* @return {Boolean}
* @public
*/
remove: function (key) {
var result = false;
if (!!key) {
key += ''; // make it a string
try {
storage.removeItem(key);
result = true;
} catch (e) {
App.log({
args: e.message,
me: 'Storage',
fx: 'error'
});
result = false;
}
}
return result;
},
/**
* Delete the data from the storage matching
* the Regular Expression or all the data if none is provided
* @name clear
* @memberof storage
* @method
* @param {RegExp} regexp Regular Expression to match the key
* @return {Boolean}
* @public
*/
clear: function (regexp) {
var result = false;
try {
if (!regexp) {
storage.clear();
} else {
var remove = [];
for (var i = 0; i < storage.length; i++) {
var key = storage.key(i);
if (regexp.test(key)) {
remove.push(key);
}
}
for (i = 0; i < remove.length; i++) {
storage.removeItem(remove[i]);
}
}
result = true;
} catch (e) {
App.log({
args: e.message,
me: 'Storage',
fx: 'error'
});
result = false;
}
return result;
}
};
};
global.App = $.extend(true, global.App, {
storage: {
/**
* Factory of the storage object
* @name factory
* @method
* @memberof storage
* @returns {Object} All storage's methods
* @public
*/
factory: storage,
/**
* Storage methods in localStorage mode
* @name local
* @constant
* @public
* @memberof storage
*/
local: storage(window.localStorage),
/**
* Storage methods in sessionStorage mode
* @name session
* @constant
* @public
* @memberof storage
*/
session: storage(window.sessionStorage)
}
});
})(jQuery, window);