@aws-amplify/cache
Version:
Cache category of aws-amplify
104 lines • 4.43 kB
JavaScript
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { getCurrTime, getByteLength, defaultConfig, isInteger } from './Utils';
import { ConsoleLogger as Logger } from '@aws-amplify/core';
var logger = new Logger('StorageCache');
/**
* Initialization of the cache
*
*/
var StorageCache = /** @class */ (function () {
/**
* Initialize the cache
* @param config - the configuration of the cache
*/
function StorageCache(config) {
this.config = Object.assign({}, config);
this.cacheCurSizeKey = this.config.keyPrefix + 'CurSize';
this.checkConfig();
}
StorageCache.prototype.getModuleName = function () {
return 'Cache';
};
StorageCache.prototype.checkConfig = function () {
// check configuration
if (!isInteger(this.config.capacityInBytes)) {
logger.error('Invalid parameter: capacityInBytes. It should be an Integer. Setting back to default.');
this.config.capacityInBytes = defaultConfig.capacityInBytes;
}
if (!isInteger(this.config.itemMaxSize)) {
logger.error('Invalid parameter: itemMaxSize. It should be an Integer. Setting back to default.');
this.config.itemMaxSize = defaultConfig.itemMaxSize;
}
if (!isInteger(this.config.defaultTTL)) {
logger.error('Invalid parameter: defaultTTL. It should be an Integer. Setting back to default.');
this.config.defaultTTL = defaultConfig.defaultTTL;
}
if (!isInteger(this.config.defaultPriority)) {
logger.error('Invalid parameter: defaultPriority. It should be an Integer. Setting back to default.');
this.config.defaultPriority = defaultConfig.defaultPriority;
}
if (this.config.itemMaxSize > this.config.capacityInBytes) {
logger.error('Invalid parameter: itemMaxSize. It should be smaller than capacityInBytes. Setting back to default.');
this.config.itemMaxSize = defaultConfig.itemMaxSize;
}
if (this.config.defaultPriority > 5 || this.config.defaultPriority < 1) {
logger.error('Invalid parameter: defaultPriority. It should be between 1 and 5. Setting back to default.');
this.config.defaultPriority = defaultConfig.defaultPriority;
}
if (Number(this.config.warningThreshold) > 1 ||
Number(this.config.warningThreshold) < 0) {
logger.error('Invalid parameter: warningThreshold. It should be between 0 and 1. Setting back to default.');
this.config.warningThreshold = defaultConfig.warningThreshold;
}
// set 5MB limit
var cacheLimit = 5 * 1024 * 1024;
if (this.config.capacityInBytes > cacheLimit) {
logger.error('Cache Capacity should be less than 5MB. Setting back to default. Setting back to default.');
this.config.capacityInBytes = defaultConfig.capacityInBytes;
}
};
/**
* produce a JSON object with meta-data and data value
* @param value - the value of the item
* @param options - optional, the specified meta-data
*
* @return - the item which has the meta-data and the value
*/
StorageCache.prototype.fillCacheItem = function (key, value, options) {
var ret = {
key: key,
data: value,
timestamp: getCurrTime(),
visitedTime: getCurrTime(),
priority: options.priority,
expires: options.expires,
type: typeof value,
byteSize: 0,
};
ret.byteSize = getByteLength(JSON.stringify(ret));
// for accurate size
ret.byteSize = getByteLength(JSON.stringify(ret));
return ret;
};
/**
* set cache with customized configuration
* @param config - customized configuration
*
* @return - the current configuration
*/
StorageCache.prototype.configure = function (config) {
if (!config) {
return this.config;
}
if (config.keyPrefix) {
logger.warn("Don't try to configure keyPrefix!");
}
this.config = Object.assign({}, this.config, config, config.Cache);
this.checkConfig();
return this.config;
};
return StorageCache;
}());
export { StorageCache };
//# sourceMappingURL=StorageCache.js.map