@toreda/cache/dist/cache/item.js

Time-based object cache in TypeScript.

"use strict";
/**
 *	MIT License
 *
 *	Copyright (c) 2019 - 2022 Toreda, Inc.
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:

 * 	The above copyright notice and this permission notice shall be included in all
 * 	copies or substantial portions of the Software.
 *
 * 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * 	SOFTWARE.
 *
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.CacheItem = void 0;
const time_1 = require("@toreda/time");
const defaults_1 = require("../defaults");
const strong_types_1 = require("@toreda/strong-types");
/**
 * Wraps generic cache items and stores meta data about the item.
 *
 * @category Cache
 */
class CacheItem {
    constructor(data, ttl) {
        this.data = data;
        this.created = (0, time_1.timeNow)();
        this.updated = (0, time_1.timeMake)('s', 0);
        this.ttl = (0, time_1.timeMake)('s', (0, strong_types_1.numberValue)(ttl, defaults_1.Defaults.CacheItem.TTL));
    }
    /**
     * Check whether this item is expired.
     * @returns
     */
    expired() {
        const ttl = this.ttl();
        // Based on DNS conventions, items with 0 TTL don't expire until forcefully cleared.
        if (ttl === 0) {
            return false;
        }
        const now = (0, time_1.timeNow)();
        let elapsed;
        if (this.updated() > 0) {
            elapsed = now.since(this.updated);
        }
        else {
            elapsed = now.since(this.created);
        }
        return elapsed === null || elapsed() >= ttl;
    }
    update() {
        this.updated.setNow();
    }
}
exports.CacheItem = CacheItem;