@darco2903/expiry-cache 2.0.2 → 2.1.0

package/dist/ExpiryCacheBase.d.ts

@@ -1,15 +1,30 @@
-import { type Time, Millisecond } from "@darco2903/secondthought";
+import { Time, Millisecond } from "@darco2903/secondthought";
 import type { RefreshFunction, RefreshFunctionAsync } from "./types.js";
 export declare abstract class ExpiryCacheBase<T, U extends RefreshFunction<T> | RefreshFunctionAsync<T>> {
+    /** The cached data. */
     protected data: T;
+    /** The function to refresh the cached data. */
     protected callback: U;
-    readonly expirationTime: number;
+    /** The time in milliseconds after which the cache expires. 0 means never expires. */
+    protected _expirationTime: Millisecond;
     /** The expiration timestamp in milliseconds. 0 means never expires, -1 means already expired or no data. */
     protected _expiresAt: Millisecond;
+    /**
+     * Gets the expiration time in milliseconds. This is the duration after which the cache expires, not the absolute expiration timestamp.
+     */
+    get expirationTime(): number;
+    /**
+     * Gets the expiration time as a Millisecond object. This is the duration after which the cache expires, not the absolute expiration timestamp.
+     */
+    get expirationTimeAsTime(): Millisecond;
     /**
      * Gets the expiration timestamp in milliseconds.
      */
     get expiresAt(): number;
+    /**
+     * Gets the expiration timestamp as a Millisecond object.
+     */
+    get expiresAtAsTime(): Millisecond;
     /**
      * Checks if the cache is set to expire.
      */
@@ -19,9 +34,13 @@ export declare abstract class ExpiryCacheBase<T, U extends RefreshFunction<T> |
      */
     get isExpired(): boolean;
     /**
-     * Gets the time to live (TTL) in milliseconds.
+     * Gets the time to live (TTL) in milliseconds. Returns null if the cache does not expire.
      */
     get timeToLive(): number | null;
+    /**
+     * Gets the time to live (TTL) as a Millisecond object. Returns null if the cache does not expire.
+     */
+    get timeToLiveAsTime(): Millisecond | null;
     /**
      * Converts a number or Time object to milliseconds.
      */

package/dist/ExpiryCacheBase.js

@@ -1,11 +1,29 @@
-import { Millisecond, Minute } from "@darco2903/secondthought";
+import { Time, Millisecond, Minute } from "@darco2903/secondthought";
 export class ExpiryCacheBase {
+    /**
+     * Gets the expiration time in milliseconds. This is the duration after which the cache expires, not the absolute expiration timestamp.
+     */
+    get expirationTime() {
+        return this._expirationTime.time;
+    }
+    /**
+     * Gets the expiration time as a Millisecond object. This is the duration after which the cache expires, not the absolute expiration timestamp.
+     */
+    get expirationTimeAsTime() {
+        return this._expirationTime;
+    }
     /**
      * Gets the expiration timestamp in milliseconds.
      */
     get expiresAt() {
         return this._expiresAt.time;
     }
+    /**
+     * Gets the expiration timestamp as a Millisecond object.
+     */
+    get expiresAtAsTime() {
+        return this._expiresAt;
+    }
     /**
      * Checks if the cache is set to expire.
      */
@@ -19,7 +37,7 @@ export class ExpiryCacheBase {
         return this.doesExpire && Millisecond.now().greaterThanOrEqual(this._expiresAt);
     }
     /**
-     * Gets the time to live (TTL) in milliseconds.
+     * Gets the time to live (TTL) in milliseconds. Returns null if the cache does not expire.
      */
     get timeToLive() {
         if (this.doesExpire) {
@@ -27,6 +45,15 @@ export class ExpiryCacheBase {
         }
         return null;
     }
+    /**
+     * Gets the time to live (TTL) as a Millisecond object. Returns null if the cache does not expire.
+     */
+    get timeToLiveAsTime() {
+        if (this.doesExpire) {
+            return Time.max(new Millisecond(0), this._expiresAt.clone().sub(Millisecond.now())).toMillisecond();
+        }
+        return null;
+    }
     /**
      * Converts a number or Time object to milliseconds.
      */
@@ -43,7 +70,7 @@ export class ExpiryCacheBase {
         const expTime = this.argToMs(expirationTime);
         this.data = data;
         this._expiresAt = expTime.time === 0 ? expTime : Millisecond.now().add(expTime);
-        this.expirationTime = expTime.time;
+        this._expirationTime = expTime;
         this.callback = callback;
     }
     /**
@@ -80,7 +107,7 @@ export class ExpiryCacheBase {
      * Sets the cached data and resets the expiration timestamp based on the expiration time.
      */
     setData(data) {
-        this.setDataExpiresIn(data, new Millisecond(this.expirationTime));
+        this.setDataExpiresIn(data, this._expirationTime);
     }
     /**
      * Sets the cached data and sets a new expiration timestamp.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darco2903/expiry-cache",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "author": "Darco2903",
   "description": "",
   "keywords": [],