@darco2903/expiry-cache 2.0.2 → 3.0.0

package/dist/ExpiryCacheBase.js

@@ -1,115 +0,0 @@
-import { Millisecond, Minute } from "@darco2903/secondthought";
-export class ExpiryCacheBase {
-    /**
-     * Gets the expiration timestamp in milliseconds.
-     */
-    get expiresAt() {
-        return this._expiresAt.time;
-    }
-    /**
-     * Checks if the cache is set to expire.
-     */
-    get doesExpire() {
-        return this._expiresAt.time !== 0;
-    }
-    /**
-     * Checks if the cache is expired.
-     */
-    get isExpired() {
-        return this.doesExpire && Millisecond.now().greaterThanOrEqual(this._expiresAt);
-    }
-    /**
-     * Gets the time to live (TTL) in milliseconds.
-     */
-    get timeToLive() {
-        if (this.doesExpire) {
-            return Math.max(0, this._expiresAt.clone().sub(Millisecond.now()).time);
-        }
-        return null;
-    }
-    /**
-     * Converts a number or Time object to milliseconds.
-     */
-    argToMs(arg) {
-        return typeof arg === "number" ? new Millisecond(arg) : arg.toMillisecond();
-    }
-    /**
-     * Creates an instance of ExpiryCache.
-     * @param data  The initial data to be cached.
-     * @param callback The function to refresh the cached data.
-     * @param expirationTime The time in milliseconds after which the cache expires. Defaults to 60_000 (1 minute). If set to 0, the cache will never expire.
-     */
-    constructor(data, callback, expirationTime = new Minute(1)) {
-        const expTime = this.argToMs(expirationTime);
-        this.data = data;
-        this._expiresAt = expTime.time === 0 ? expTime : Millisecond.now().add(expTime);
-        this.expirationTime = expTime.time;
-        this.callback = callback;
-    }
-    /**
-     * Expires the cache immediately.
-     */
-    expire() {
-        this._expiresAt = new Millisecond(-1);
-    }
-    /**
-     * Sets the cache to never expire.
-     */
-    neverExpire() {
-        this._expiresAt = new Millisecond(0);
-    }
-    expIn(ms) {
-        return ms.time === 0 ? ms : Millisecond.now().add(ms);
-    }
-    /**
-     * Sets the expiration timestamp based on the current time plus the given milliseconds.
-     * @param ms The time in milliseconds after which the cache should expire. If set to 0, the cache will never expire.
-     */
-    setExpiresIn(ms) {
-        const t = this.argToMs(ms);
-        this._expiresAt = this.expIn(t);
-    }
-    /**
-     * Sets the expiration timestamp to a specific time.
-     * @param timestamp The expiration timestamp in milliseconds.
-     */
-    setExpiresAt(timestamp) {
-        this._expiresAt = this.argToMs(timestamp);
-    }
-    /**
-     * Sets the cached data and resets the expiration timestamp based on the expiration time.
-     */
-    setData(data) {
-        this.setDataExpiresIn(data, new Millisecond(this.expirationTime));
-    }
-    /**
-     * Sets the cached data and sets a new expiration timestamp.
-     * @param expiresAt The new expiration timestamp in milliseconds.
-     */
-    setDataExpiresAt(data, expiresAt) {
-        this.data = data;
-        this._expiresAt = expiresAt;
-    }
-    /**
-     * Sets the cached data and sets a new expiration time.
-     * @param expirationTime The new expiration time in milliseconds.
-     */
-    setDataExpiresIn(data, expirationTime) {
-        this.setDataExpiresAt(data, this.expIn(expirationTime));
-    }
-    /**
-     * Gets the raw cached data without checking expiration.
-     */
-    getRawData() {
-        return this.data;
-    }
-    /**
-     * Gets the cached data if not expired, otherwise returns null.
-     */
-    getData() {
-        if (this.isExpired) {
-            return null;
-        }
-        return this.data;
-    }
-}

package/dist/types.d.ts

@@ -1,2 +0,0 @@
-export type RefreshFunction<T> = (...args: any[]) => T;
-export type RefreshFunctionAsync<T> = (...args: any[]) => Promise<T>;