Usage
nebula.memoize(action, handle, value)
Parameters
action
(Required) (String) Whether to "get" or "set" the cache for the desired handle
Default: None
handle
(Required) (String) The name of the cache to use
Default: None
value
(Optional) (Mixed) The value to associate with the handle
Default: None
Parameter Notes
Note the value is only required when using the “set” action.
Handles can be human-readable strings and are not case-sensitive.
Examples
Use it to call an expensive function
let example = nebula.memoize('get', 'my first memoize');
if ( !example ){
example = nebula.memoize('set', 'my first memoize', expensiveFunctionHere()); //memoize returns the value so it can be used inline like this
}
console.log('Result:', example); //Use the result of the expensive function now
Use it inside of an expensive function
function expensiveFunctionHere(){
let example = nebula.memoize('get', 'my expensive function');
if ( !example ){
let example = 42; //Do the expensive functionality now
nebula.memoize('set', 'my expensive function', example);
}
return example;
}
Additional Notes
The Nebula memoize function is treated similarly to the WordPress Transient API.
Source File
Located in /assets/js/modules/utilities.js on line 516.
No Hooks
This function does not have any filters or actions available. Request one?nebula.memoize = function(action, handle = '', value = false){
nebula.memoizeCache = nebula.memoizeCache || {};
if ( action.toLowerCase() === 'set' ){
nebula.memoizeCache[handle] = value;
return value; //Returning the set value allows for memoize to be set inline with the calculated value if desired
}
if ( action.toLowerCase() === 'get' ){
if ( handle in nebula.memoizeCache ){
return nebula.memoizeCache[handle];
}
}
return false;
};
Override
To override or disable this JavaScript function, simply redeclare it with the exact same function name. Remember: Some functionality is conditionally loaded via dynamic imports, so if your function is not overriding properly, try listening for a DOM event (described below).
For non-module import functions:
nebula.memoize = function(action, handle, value){
//Write your own code here, leave it blank, or return false.
}
For dynamically imported module function overrides:
jQuery(window).on('load', function(){
nebula.memoize = function(action, handle, value){
//Write your own code here, leave it blank, or return false.
}
});
Custom Nebula DOM events do also exist, so you could also try the following if the Window Load listener does not work:
jQuery(document).on('nebula_module_loaded', function(module){
//Note that the module variable is also available to know which module specifically was imported
if ( typeof nebula.memoize === 'function' ){
nebula.memoize = function(action, handle, value){
//Write your own code here, leave it blank, or return false.
}
}
});