Cutlery/beestat
1
0
Fork 0
mirror of https://github.com/beestat/app.git synced 2025-06-23 15:30:43 -04:00
Code Actions Packages Releases Activity

Added documentation to cache

Browse Source
This commit is contained in:
Jon Ziebell 2021-01-23 13:46:21 -05:00
parent 206af04d46
commit d9fd07618a
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
js/beestat/cache.js
View File

@ -2,6 +2,12 @@ beestat.cache = {
'data': {} 'data': {}
}; };
/**
* Overwrite a cache key with new data. Dispatches an event when done.
*
* @param {string} key The cache key to update.
* @param {object} value The data to be placed in that key.
*/
beestat.cache.set = function(key, value) { beestat.cache.set = function(key, value) {
if (key.substring(0, 5) === 'data.') { if (key.substring(0, 5) === 'data.') {
beestat.cache.data[key.substring(5)] = value; beestat.cache.data[key.substring(5)] = value;
@ -11,6 +17,11 @@ beestat.cache.set = function(key, value) {
beestat.dispatcher.dispatchEvent('cache.' + key); beestat.dispatcher.dispatchEvent('cache.' + key);
}; };
/**
* Delete data from the cache. Dispatches an event when done.
*
* @param {string} key The cache key to delete.
*/
beestat.cache.delete = function(key) { beestat.cache.delete = function(key) {
if (key.substring(0, 5) === 'data.') { if (key.substring(0, 5) === 'data.') {
delete beestat.cache.data[key.substring(5)]; delete beestat.cache.data[key.substring(5)];