cacheable 1.1.0 → 1.3.0

package/dist/index.cjs

@@ -518,6 +518,7 @@ var Cacheable = class extends import_hookified.Hookified {
   _primary = new import_keyv.Keyv({ store: new CacheableMemory() });
   _secondary;
   _nonBlocking = false;
+  _ttl;
   _stats = new CacheableStats({ enabled: false });
   constructor(options) {
     super();
@@ -533,6 +534,9 @@ var Cacheable = class extends import_hookified.Hookified {
     if (options?.stats) {
       this._stats.enabled = options.stats;
     }
+    if (options?.ttl) {
+      this._ttl = options.ttl;
+    }
   }
   get stats() {
     return this._stats;
@@ -555,6 +559,12 @@ var Cacheable = class extends import_hookified.Hookified {
   set nonBlocking(nonBlocking) {
     this._nonBlocking = nonBlocking;
   }
+  get ttl() {
+    return this._ttl;
+  }
+  set ttl(ttl) {
+    this._ttl = ttl;
+  }
   setPrimary(primary) {
     this._primary = primary instanceof import_keyv.Keyv ? primary : new import_keyv.Keyv(primary);
   }
@@ -569,12 +579,12 @@ var Cacheable = class extends import_hookified.Hookified {
       if (!result && this._secondary) {
         result = await this._secondary.get(key);
         if (result) {
-          await this._primary.set(key, result);
+          await this._primary.set(key, result, this._ttl);
         }
       }
       await this.hook("AFTER_GET" /* AFTER_GET */, { key, result });
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       if (result) {
@@ -602,13 +612,13 @@ var Cacheable = class extends import_hookified.Hookified {
         for (const [i, key] of keys.entries()) {
           if (!result[i] && secondaryResult[i]) {
             result[i] = secondaryResult[i];
-            await this._primary.set(key, secondaryResult[i]);
+            await this._primary.set(key, secondaryResult[i], this._ttl);
           }
         }
       }
       await this.hook("AFTER_GET_MANY" /* AFTER_GET_MANY */, { keys, result });
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       for (const item of result) {
@@ -624,12 +634,14 @@ var Cacheable = class extends import_hookified.Hookified {
   }
   async set(key, value, ttl) {
     let result = false;
+    const finalTtl = ttl ?? this._ttl;
     try {
-      await this.hook("BEFORE_SET" /* BEFORE_SET */, { key, value, ttl });
+      const item = { key, value, ttl: finalTtl };
+      await this.hook("BEFORE_SET" /* BEFORE_SET */, item);
       const promises = [];
-      promises.push(this._primary.set(key, value, ttl));
+      promises.push(this._primary.set(item.key, item.value, item.ttl));
       if (this._secondary) {
-        promises.push(this._secondary.set(key, value, ttl));
+        promises.push(this._secondary.set(item.key, item.value, item.ttl));
       }
       if (this._nonBlocking) {
         result = await Promise.race(promises);
@@ -637,9 +649,9 @@ var Cacheable = class extends import_hookified.Hookified {
         const results = await Promise.all(promises);
         result = results[0];
       }
-      await this.hook("AFTER_SET" /* AFTER_SET */, { key, value, ttl });
+      await this.hook("AFTER_SET" /* AFTER_SET */, item);
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       this.stats.incrementKSize(key);
@@ -663,7 +675,7 @@ var Cacheable = class extends import_hookified.Hookified {
       }
       await this.hook("AFTER_SET_MANY" /* AFTER_SET_MANY */, items);
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       for (const item of items) {
@@ -791,7 +803,8 @@ var Cacheable = class extends import_hookified.Hookified {
   async setManyKeyv(keyv, items) {
     const promises = [];
     for (const item of items) {
-      promises.push(keyv.set(item.key, item.value, item.ttl));
+      const finalTtl = item.ttl ?? this._ttl;
+      promises.push(keyv.set(item.key, item.value, finalTtl));
     }
     await Promise.all(promises);
     return true;

package/dist/index.d.cts

@@ -115,11 +115,13 @@ type CacheableOptions = {
     secondary?: Keyv | KeyvStoreAdapter;
     stats?: boolean;
     nonBlocking?: boolean;
+    ttl?: number;
 };
 declare class Cacheable extends Hookified {
     private _primary;
     private _secondary;
     private _nonBlocking;
+    private _ttl?;
     private readonly _stats;
     constructor(options?: CacheableOptions);
     get stats(): CacheableStats;
@@ -129,6 +131,8 @@ declare class Cacheable extends Hookified {
     set secondary(secondary: Keyv | undefined);
     get nonBlocking(): boolean;
     set nonBlocking(nonBlocking: boolean);
+    get ttl(): number | undefined;
+    set ttl(ttl: number | undefined);
     setPrimary(primary: Keyv | KeyvStoreAdapter): void;
     setSecondary(secondary: Keyv | KeyvStoreAdapter): void;
     get<T>(key: string): Promise<T | undefined>;

package/dist/index.d.ts

@@ -115,11 +115,13 @@ type CacheableOptions = {
     secondary?: Keyv | KeyvStoreAdapter;
     stats?: boolean;
     nonBlocking?: boolean;
+    ttl?: number;
 };
 declare class Cacheable extends Hookified {
     private _primary;
     private _secondary;
     private _nonBlocking;
+    private _ttl?;
     private readonly _stats;
     constructor(options?: CacheableOptions);
     get stats(): CacheableStats;
@@ -129,6 +131,8 @@ declare class Cacheable extends Hookified {
     set secondary(secondary: Keyv | undefined);
     get nonBlocking(): boolean;
     set nonBlocking(nonBlocking: boolean);
+    get ttl(): number | undefined;
+    set ttl(ttl: number | undefined);
     setPrimary(primary: Keyv | KeyvStoreAdapter): void;
     setSecondary(secondary: Keyv | KeyvStoreAdapter): void;
     get<T>(key: string): Promise<T | undefined>;

package/dist/index.js

@@ -490,6 +490,7 @@ var Cacheable = class extends Hookified {
   _primary = new Keyv({ store: new CacheableMemory() });
   _secondary;
   _nonBlocking = false;
+  _ttl;
   _stats = new CacheableStats({ enabled: false });
   constructor(options) {
     super();
@@ -505,6 +506,9 @@ var Cacheable = class extends Hookified {
     if (options?.stats) {
       this._stats.enabled = options.stats;
     }
+    if (options?.ttl) {
+      this._ttl = options.ttl;
+    }
   }
   get stats() {
     return this._stats;
@@ -527,6 +531,12 @@ var Cacheable = class extends Hookified {
   set nonBlocking(nonBlocking) {
     this._nonBlocking = nonBlocking;
   }
+  get ttl() {
+    return this._ttl;
+  }
+  set ttl(ttl) {
+    this._ttl = ttl;
+  }
   setPrimary(primary) {
     this._primary = primary instanceof Keyv ? primary : new Keyv(primary);
   }
@@ -541,12 +551,12 @@ var Cacheable = class extends Hookified {
       if (!result && this._secondary) {
         result = await this._secondary.get(key);
         if (result) {
-          await this._primary.set(key, result);
+          await this._primary.set(key, result, this._ttl);
         }
       }
       await this.hook("AFTER_GET" /* AFTER_GET */, { key, result });
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       if (result) {
@@ -574,13 +584,13 @@ var Cacheable = class extends Hookified {
         for (const [i, key] of keys.entries()) {
           if (!result[i] && secondaryResult[i]) {
             result[i] = secondaryResult[i];
-            await this._primary.set(key, secondaryResult[i]);
+            await this._primary.set(key, secondaryResult[i], this._ttl);
           }
         }
       }
       await this.hook("AFTER_GET_MANY" /* AFTER_GET_MANY */, { keys, result });
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       for (const item of result) {
@@ -596,12 +606,14 @@ var Cacheable = class extends Hookified {
   }
   async set(key, value, ttl) {
     let result = false;
+    const finalTtl = ttl ?? this._ttl;
     try {
-      await this.hook("BEFORE_SET" /* BEFORE_SET */, { key, value, ttl });
+      const item = { key, value, ttl: finalTtl };
+      await this.hook("BEFORE_SET" /* BEFORE_SET */, item);
       const promises = [];
-      promises.push(this._primary.set(key, value, ttl));
+      promises.push(this._primary.set(item.key, item.value, item.ttl));
       if (this._secondary) {
-        promises.push(this._secondary.set(key, value, ttl));
+        promises.push(this._secondary.set(item.key, item.value, item.ttl));
       }
       if (this._nonBlocking) {
         result = await Promise.race(promises);
@@ -609,9 +621,9 @@ var Cacheable = class extends Hookified {
         const results = await Promise.all(promises);
         result = results[0];
       }
-      await this.hook("AFTER_SET" /* AFTER_SET */, { key, value, ttl });
+      await this.hook("AFTER_SET" /* AFTER_SET */, item);
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       this.stats.incrementKSize(key);
@@ -635,7 +647,7 @@ var Cacheable = class extends Hookified {
       }
       await this.hook("AFTER_SET_MANY" /* AFTER_SET_MANY */, items);
     } catch (error) {
-      await this.emit("error" /* ERROR */, error);
+      this.emit("error" /* ERROR */, error);
     }
     if (this.stats.enabled) {
       for (const item of items) {
@@ -763,7 +775,8 @@ var Cacheable = class extends Hookified {
   async setManyKeyv(keyv, items) {
     const promises = [];
     for (const item of items) {
-      promises.push(keyv.set(item.key, item.value, item.ttl));
+      const finalTtl = item.ttl ?? this._ttl;
+      promises.push(keyv.set(item.key, item.value, finalTtl));
     }
     await Promise.all(promises);
     return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cacheable",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Simple Caching Engine using Keyv",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -28,9 +28,35 @@
     "xo": "^0.59.3"
   },
   "dependencies": {
-    "hookified": "^0.7.1",
-    "keyv": "^5.0.1"
+    "hookified": "^1.1.0",
+    "keyv": "^5.0.3"
   },
+  "keywords": [
+    "cacheable",
+    "high performance",
+    "layer 1 caching",
+    "layer 2 caching",
+    "distributed caching",
+    "Keyv storage engine",
+    "memory caching",
+    "LRU cache",
+    "expiration",
+    "CacheableMemory",
+    "offline support",
+    "distributed sync",
+    "secondary store",
+    "primary store",
+    "non-blocking operations",
+    "cache statistics",
+    "layered caching",
+    "fault tolerant",
+    "scalable cache",
+    "in-memory cache",
+    "distributed cache",
+    "lruSize",
+    "lru",
+    "multi-tier cache"
+  ],
   "files": [
     "dist",
     "LICENSE"