wikimedia/mediawiki-extensions-MobileFrontend

View on GitHub
src/mobile.startup/cache.js

Summary

Maintainability
A
0 mins
Test Coverage
/* This module defines several types of cache classes to use in other
 * modules.
 * The interface, that all types use, is kept synchronous driven by current
 * usage patterns, but will need to be revisited in case usage patterns
 * suggest we need asynchronous caches.
 */

/**
 * In memory cache implementation
 *
 * @class MemoryCache
 * @private
 */
function MemoryCache() {
    this._cache = {};
}

/**
 * Retrieve a cached value from a key
 *
 * @memberof MemoryCache
 * @instance
 * @param {string} key
 * @return {any}
 */
MemoryCache.prototype.get = function ( key ) {
    return this._cache[ key ];
};

/**
 * Cache a value by key
 *
 * @memberof MemoryCache
 * @instance
 * @param {string} key
 * @param {any} value
 */
MemoryCache.prototype.set = function ( key, value ) {
    this._cache[ key ] = value;
};

/**
 * Null object cache implementation
 *
 * @class NoCache
 */
function NoCache() { }

/**
 * NoOp
 *
 * @memberof NoCache
 * @instance
 */
NoCache.prototype.get = function () { };

/**
 * NoOp
 *
 * @memberof NoCache
 * @instance
 */
NoCache.prototype.set = function () { };

module.exports = {
    MemoryCache,
    NoCache
};