cacheable 1.8.5 → 1.8.7

package/README.md

@@ -1,8 +1,6 @@
 [<img align="center" src="https://cacheable.org/logo.svg" alt="Cacheable" />](https://github.com/jaredwray/cacheable)
 
-# Cacheable
-
-> Simple Caching Engine using Keyv
+> High Performance Layer 1 / Layer 2 Caching with Keyv Storage
 
 [![codecov](https://codecov.io/gh/jaredwray/cacheable/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cacheable)
 [![tests](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml/badge.svg)](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml)
@@ -375,7 +373,7 @@ import { KeyvCacheableMemory } from 'cacheable';
 
 const keyv = new Keyv({ store: new KeyvCacheableMemory() });
 await keyv.set('foo', 'bar');
-const value = await keyv.get('key');
+const value = await keyv.get('foo');
 console.log(value); // bar 
 ```
 

package/dist/index.cjs

@@ -28,23 +28,24 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   Cacheable: () => Cacheable,
   CacheableEvents: () => CacheableEvents,
   CacheableHooks: () => CacheableHooks,
   CacheableMemory: () => CacheableMemory,
   CacheableStats: () => CacheableStats,
-  Keyv: () => import_keyv2.Keyv,
+  Keyv: () => import_keyv3.Keyv,
   KeyvCacheableMemory: () => KeyvCacheableMemory,
-  KeyvHooks: () => import_keyv2.KeyvHooks,
+  KeyvHooks: () => import_keyv3.KeyvHooks,
+  createKeyv: () => createKeyv,
   shorthandToMilliseconds: () => shorthandToMilliseconds,
   shorthandToTime: () => shorthandToTime,
   wrap: () => wrap,
   wrapSync: () => wrapSync
 });
-module.exports = __toCommonJS(src_exports);
-var import_keyv = require("keyv");
+module.exports = __toCommonJS(index_exports);
+var import_keyv2 = require("keyv");
 var import_hookified2 = require("hookified");
 
 // src/shorthand-time.ts
@@ -114,6 +115,9 @@ var shorthandToTime = (shorthand, fromDate) => {
   return fromDate.getTime() + milliseconds;
 };
 
+// src/keyv-memory.ts
+var import_keyv = require("keyv");
+
 // src/memory.ts
 var import_hookified = require("hookified");
 
@@ -496,7 +500,8 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * Sets the value of the key
    * @param {string} key - The key to set the value
    * @param {any} value - The value to set
-   * @param {number|string} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+   * @param {number|string|SetOptions} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+   * If you want to set expire directly you can do that by setting the expire property in the SetOptions.
    * If you set undefined, it will use the default time-to-live. If both are undefined then it will not have a time-to-live.
    * @returns {void}
    */
@@ -504,9 +509,21 @@ var CacheableMemory = class extends import_hookified.Hookified {
     const store = this.getStore(key);
     let expires;
     if (ttl !== void 0 || this._ttl !== void 0) {
-      const finalTtl = shorthandToTime(ttl ?? this._ttl);
-      if (finalTtl !== void 0) {
-        expires = finalTtl;
+      if (typeof ttl === "object") {
+        if (ttl.expire) {
+          expires = typeof ttl.expire === "number" ? ttl.expire : ttl.expire.getTime();
+        }
+        if (ttl.ttl) {
+          const finalTtl = shorthandToTime(ttl.ttl);
+          if (finalTtl !== void 0) {
+            expires = finalTtl;
+          }
+        }
+      } else {
+        const finalTtl = shorthandToTime(ttl ?? this._ttl);
+        if (finalTtl !== void 0) {
+          expires = finalTtl;
+        }
       }
     }
     if (this._lruSize > 0) {
@@ -757,9 +774,12 @@ var CacheableMemory = class extends import_hookified.Hookified {
    */
   startIntervalCheck() {
     if (this._checkInterval > 0) {
+      if (this._interval) {
+        clearInterval(this._interval);
+      }
       this._interval = setInterval(() => {
         this.checkExpiration();
-      }, this._checkInterval);
+      }, this._checkInterval).unref();
     }
   }
   /**
@@ -895,6 +915,18 @@ var KeyvCacheableMemory = class {
     return this._nCache.get(namespace);
   }
 };
+function createKeyv(options) {
+  const store = new KeyvCacheableMemory(options);
+  const namespace = options?.namespace;
+  let ttl;
+  if (options?.ttl && Number.isInteger(options.ttl)) {
+    ttl = options?.ttl;
+  }
+  const keyv = new import_keyv.Keyv({ store, namespace, ttl });
+  keyv.serialize = void 0;
+  keyv.deserialize = void 0;
+  return keyv;
+}
 
 // src/stats.ts
 var CacheableStats = class {
@@ -1114,7 +1146,7 @@ var CacheableStats = class {
 };
 
 // src/index.ts
-var import_keyv2 = require("keyv");
+var import_keyv3 = require("keyv");
 var CacheableHooks = /* @__PURE__ */ ((CacheableHooks2) => {
   CacheableHooks2["BEFORE_SET"] = "BEFORE_SET";
   CacheableHooks2["AFTER_SET"] = "AFTER_SET";
@@ -1131,7 +1163,7 @@ var CacheableEvents = /* @__PURE__ */ ((CacheableEvents2) => {
   return CacheableEvents2;
 })(CacheableEvents || {});
 var Cacheable = class extends import_hookified2.Hookified {
-  _primary = new import_keyv.Keyv({ store: new KeyvCacheableMemory() });
+  _primary = createKeyv();
   _secondary;
   _nonBlocking = false;
   _ttl;
@@ -1290,7 +1322,7 @@ var Cacheable = class extends import_hookified2.Hookified {
    * @returns {void}
    */
   setPrimary(primary) {
-    this._primary = primary instanceof import_keyv.Keyv ? primary : new import_keyv.Keyv(primary);
+    this._primary = primary instanceof import_keyv2.Keyv ? primary : new import_keyv2.Keyv(primary);
     this._primary.on("error", (error) => {
       this.emit("error" /* ERROR */, error);
     });
@@ -1301,7 +1333,7 @@ var Cacheable = class extends import_hookified2.Hookified {
    * @returns {void}
    */
   setSecondary(secondary) {
-    this._secondary = secondary instanceof import_keyv.Keyv ? secondary : new import_keyv.Keyv(secondary);
+    this._secondary = secondary instanceof import_keyv2.Keyv ? secondary : new import_keyv2.Keyv(secondary);
     this._secondary.on("error", (error) => {
       this.emit("error" /* ERROR */, error);
     });
@@ -1665,6 +1697,7 @@ var Cacheable = class extends import_hookified2.Hookified {
   Keyv,
   KeyvCacheableMemory,
   KeyvHooks,
+  createKeyv,
   shorthandToMilliseconds,
   shorthandToTime,
   wrap,

package/dist/index.d.cts

@@ -139,6 +139,10 @@ type CacheableMemoryOptions = {
     lruSize?: number;
     checkInterval?: number;
 };
+type SetOptions = {
+    ttl?: number | string;
+    expire?: number | Date;
+};
 declare class CacheableMemory extends Hookified {
     private _lru;
     private readonly _hashCache;
@@ -245,11 +249,12 @@ declare class CacheableMemory extends Hookified {
      * Sets the value of the key
      * @param {string} key - The key to set the value
      * @param {any} value - The value to set
-     * @param {number|string} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+     * @param {number|string|SetOptions} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+     * If you want to set expire directly you can do that by setting the expire property in the SetOptions.
      * If you set undefined, it will use the default time-to-live. If both are undefined then it will not have a time-to-live.
      * @returns {void}
      */
-    set(key: string, value: any, ttl?: number | string): void;
+    set(key: string, value: any, ttl?: number | string | SetOptions): void;
     /**
      * Sets the values of the keys
      * @param {CacheableItem[]} items - The items to set
@@ -366,7 +371,7 @@ declare class CacheableMemory extends Hookified {
      * @param {Object} [options] - The options to wrap
      * @returns {Function} - The wrapped function
      */
-    wrap<T>(function_: (...arguments_: any[]) => T, options?: WrapFunctionOptions): (...arguments_: any[]) => T;
+    wrap<T, Arguments extends any[]>(function_: (...arguments_: Arguments) => T, options?: WrapFunctionOptions): (...arguments_: Arguments) => T;
     private isPrimitive;
     private concatStores;
     private setTtl;
@@ -399,6 +404,12 @@ declare class KeyvCacheableMemory implements KeyvStoreAdapter {
     on(event: string, listener: (...arguments_: any[]) => void): this;
     getStore(namespace?: string): CacheableMemory;
 }
+/**
+ * Creates a new Keyv instance with a new KeyvCacheableMemory store. This also removes the serialize/deserialize methods from the Keyv instance for optimization.
+ * @param options
+ * @returns
+ */
+declare function createKeyv(options?: KeyvCacheableMemoryOptions): Keyv;
 
 declare const shorthandToMilliseconds: (shorthand?: string | number) => number | undefined;
 declare const shorthandToTime: (shorthand?: string | number, fromDate?: Date) => number;
@@ -622,7 +633,7 @@ declare class Cacheable extends Hookified {
      * @param {WrapOptions} [options] The options for the wrap function
      * @returns {Function} The wrapped function
      */
-    wrap<T>(function_: (...arguments_: any[]) => T, options?: WrapFunctionOptions): (...arguments_: any[]) => T;
+    wrap<T, Arguments extends any[]>(function_: (...arguments_: Arguments) => T, options?: WrapFunctionOptions): (...arguments_: Arguments) => T;
     /**
      * Will hash an object using the specified algorithm. The default algorithm is 'sha256'.
      * @param {any} object the object to hash
@@ -636,4 +647,4 @@ declare class Cacheable extends Hookified {
     private setTtl;
 }
 
-export { Cacheable, CacheableEvents, CacheableHooks, type CacheableItem, CacheableMemory, type CacheableMemoryOptions, type CacheableOptions, CacheableStats, KeyvCacheableMemory, type WrapOptions, type WrapSyncOptions, shorthandToMilliseconds, shorthandToTime, wrap, wrapSync };
+export { Cacheable, CacheableEvents, CacheableHooks, type CacheableItem, CacheableMemory, type CacheableMemoryOptions, type CacheableOptions, CacheableStats, KeyvCacheableMemory, type WrapOptions, type WrapSyncOptions, createKeyv, shorthandToMilliseconds, shorthandToTime, wrap, wrapSync };

package/dist/index.d.ts

@@ -139,6 +139,10 @@ type CacheableMemoryOptions = {
     lruSize?: number;
     checkInterval?: number;
 };
+type SetOptions = {
+    ttl?: number | string;
+    expire?: number | Date;
+};
 declare class CacheableMemory extends Hookified {
     private _lru;
     private readonly _hashCache;
@@ -245,11 +249,12 @@ declare class CacheableMemory extends Hookified {
      * Sets the value of the key
      * @param {string} key - The key to set the value
      * @param {any} value - The value to set
-     * @param {number|string} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+     * @param {number|string|SetOptions} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+     * If you want to set expire directly you can do that by setting the expire property in the SetOptions.
      * If you set undefined, it will use the default time-to-live. If both are undefined then it will not have a time-to-live.
      * @returns {void}
      */
-    set(key: string, value: any, ttl?: number | string): void;
+    set(key: string, value: any, ttl?: number | string | SetOptions): void;
     /**
      * Sets the values of the keys
      * @param {CacheableItem[]} items - The items to set
@@ -366,7 +371,7 @@ declare class CacheableMemory extends Hookified {
      * @param {Object} [options] - The options to wrap
      * @returns {Function} - The wrapped function
      */
-    wrap<T>(function_: (...arguments_: any[]) => T, options?: WrapFunctionOptions): (...arguments_: any[]) => T;
+    wrap<T, Arguments extends any[]>(function_: (...arguments_: Arguments) => T, options?: WrapFunctionOptions): (...arguments_: Arguments) => T;
     private isPrimitive;
     private concatStores;
     private setTtl;
@@ -399,6 +404,12 @@ declare class KeyvCacheableMemory implements KeyvStoreAdapter {
     on(event: string, listener: (...arguments_: any[]) => void): this;
     getStore(namespace?: string): CacheableMemory;
 }
+/**
+ * Creates a new Keyv instance with a new KeyvCacheableMemory store. This also removes the serialize/deserialize methods from the Keyv instance for optimization.
+ * @param options
+ * @returns
+ */
+declare function createKeyv(options?: KeyvCacheableMemoryOptions): Keyv;
 
 declare const shorthandToMilliseconds: (shorthand?: string | number) => number | undefined;
 declare const shorthandToTime: (shorthand?: string | number, fromDate?: Date) => number;
@@ -622,7 +633,7 @@ declare class Cacheable extends Hookified {
      * @param {WrapOptions} [options] The options for the wrap function
      * @returns {Function} The wrapped function
      */
-    wrap<T>(function_: (...arguments_: any[]) => T, options?: WrapFunctionOptions): (...arguments_: any[]) => T;
+    wrap<T, Arguments extends any[]>(function_: (...arguments_: Arguments) => T, options?: WrapFunctionOptions): (...arguments_: Arguments) => T;
     /**
      * Will hash an object using the specified algorithm. The default algorithm is 'sha256'.
      * @param {any} object the object to hash
@@ -636,4 +647,4 @@ declare class Cacheable extends Hookified {
     private setTtl;
 }
 
-export { Cacheable, CacheableEvents, CacheableHooks, type CacheableItem, CacheableMemory, type CacheableMemoryOptions, type CacheableOptions, CacheableStats, KeyvCacheableMemory, type WrapOptions, type WrapSyncOptions, shorthandToMilliseconds, shorthandToTime, wrap, wrapSync };
+export { Cacheable, CacheableEvents, CacheableHooks, type CacheableItem, CacheableMemory, type CacheableMemoryOptions, type CacheableOptions, CacheableStats, KeyvCacheableMemory, type WrapOptions, type WrapSyncOptions, createKeyv, shorthandToMilliseconds, shorthandToTime, wrap, wrapSync };

package/dist/index.js

@@ -1,5 +1,5 @@
 // src/index.ts
-import { Keyv } from "keyv";
+import { Keyv as Keyv2 } from "keyv";
 import { Hookified as Hookified2 } from "hookified";
 
 // src/shorthand-time.ts
@@ -69,6 +69,11 @@ var shorthandToTime = (shorthand, fromDate) => {
   return fromDate.getTime() + milliseconds;
 };
 
+// src/keyv-memory.ts
+import {
+  Keyv
+} from "keyv";
+
 // src/memory.ts
 import { Hookified } from "hookified";
 
@@ -451,7 +456,8 @@ var CacheableMemory = class extends Hookified {
    * Sets the value of the key
    * @param {string} key - The key to set the value
    * @param {any} value - The value to set
-   * @param {number|string} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+   * @param {number|string|SetOptions} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable.
+   * If you want to set expire directly you can do that by setting the expire property in the SetOptions.
    * If you set undefined, it will use the default time-to-live. If both are undefined then it will not have a time-to-live.
    * @returns {void}
    */
@@ -459,9 +465,21 @@ var CacheableMemory = class extends Hookified {
     const store = this.getStore(key);
     let expires;
     if (ttl !== void 0 || this._ttl !== void 0) {
-      const finalTtl = shorthandToTime(ttl ?? this._ttl);
-      if (finalTtl !== void 0) {
-        expires = finalTtl;
+      if (typeof ttl === "object") {
+        if (ttl.expire) {
+          expires = typeof ttl.expire === "number" ? ttl.expire : ttl.expire.getTime();
+        }
+        if (ttl.ttl) {
+          const finalTtl = shorthandToTime(ttl.ttl);
+          if (finalTtl !== void 0) {
+            expires = finalTtl;
+          }
+        }
+      } else {
+        const finalTtl = shorthandToTime(ttl ?? this._ttl);
+        if (finalTtl !== void 0) {
+          expires = finalTtl;
+        }
       }
     }
     if (this._lruSize > 0) {
@@ -712,9 +730,12 @@ var CacheableMemory = class extends Hookified {
    */
   startIntervalCheck() {
     if (this._checkInterval > 0) {
+      if (this._interval) {
+        clearInterval(this._interval);
+      }
       this._interval = setInterval(() => {
         this.checkExpiration();
-      }, this._checkInterval);
+      }, this._checkInterval).unref();
     }
   }
   /**
@@ -850,6 +871,18 @@ var KeyvCacheableMemory = class {
     return this._nCache.get(namespace);
   }
 };
+function createKeyv(options) {
+  const store = new KeyvCacheableMemory(options);
+  const namespace = options?.namespace;
+  let ttl;
+  if (options?.ttl && Number.isInteger(options.ttl)) {
+    ttl = options?.ttl;
+  }
+  const keyv = new Keyv({ store, namespace, ttl });
+  keyv.serialize = void 0;
+  keyv.deserialize = void 0;
+  return keyv;
+}
 
 // src/stats.ts
 var CacheableStats = class {
@@ -1071,7 +1104,7 @@ var CacheableStats = class {
 // src/index.ts
 import {
   KeyvHooks,
-  Keyv as Keyv2
+  Keyv as Keyv3
 } from "keyv";
 var CacheableHooks = /* @__PURE__ */ ((CacheableHooks2) => {
   CacheableHooks2["BEFORE_SET"] = "BEFORE_SET";
@@ -1089,7 +1122,7 @@ var CacheableEvents = /* @__PURE__ */ ((CacheableEvents2) => {
   return CacheableEvents2;
 })(CacheableEvents || {});
 var Cacheable = class extends Hookified2 {
-  _primary = new Keyv({ store: new KeyvCacheableMemory() });
+  _primary = createKeyv();
   _secondary;
   _nonBlocking = false;
   _ttl;
@@ -1248,7 +1281,7 @@ var Cacheable = class extends Hookified2 {
    * @returns {void}
    */
   setPrimary(primary) {
-    this._primary = primary instanceof Keyv ? primary : new Keyv(primary);
+    this._primary = primary instanceof Keyv2 ? primary : new Keyv2(primary);
     this._primary.on("error", (error) => {
       this.emit("error" /* ERROR */, error);
     });
@@ -1259,7 +1292,7 @@ var Cacheable = class extends Hookified2 {
    * @returns {void}
    */
   setSecondary(secondary) {
-    this._secondary = secondary instanceof Keyv ? secondary : new Keyv(secondary);
+    this._secondary = secondary instanceof Keyv2 ? secondary : new Keyv2(secondary);
     this._secondary.on("error", (error) => {
       this.emit("error" /* ERROR */, error);
     });
@@ -1619,9 +1652,10 @@ export {
   CacheableHooks,
   CacheableMemory,
   CacheableStats,
-  Keyv2 as Keyv,
+  Keyv3 as Keyv,
   KeyvCacheableMemory,
   KeyvHooks,
+  createKeyv,
   shorthandToMilliseconds,
   shorthandToTime,
   wrap,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cacheable",
-  "version": "1.8.5",
-  "description": "Simple Caching Engine using Keyv",
+  "version": "1.8.7",
+  "description": "High Performance Layer 1 / Layer 2 Caching with Keyv Storage",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -21,19 +21,19 @@
   "license": "MIT",
   "private": false,
   "devDependencies": {
-    "@keyv/redis": "^3.0.1",
-    "@types/node": "^22.9.0",
-    "@vitest/coverage-v8": "^2.1.4",
+    "@keyv/redis": "^4.2.0",
+    "@types/node": "^22.10.2",
+    "@vitest/coverage-v8": "^2.1.8",
     "lru-cache": "^11.0.2",
     "rimraf": "^6.0.1",
     "tsup": "^8.3.5",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.4",
-    "xo": "^0.59.3"
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8",
+    "xo": "^0.60.0"
   },
   "dependencies": {
-    "hookified": "^1.5.0",
-    "keyv": "^5.2.1"
+    "hookified": "^1.6.0",
+    "keyv": "^5.2.3"
   },
   "keywords": [
     "cacheable",
@@ -67,6 +67,7 @@
   ],
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
+    "prepublish": "pnpm build",
     "test": "xo --fix && vitest run --coverage",
     "test:ci": "xo && vitest run",
     "clean": "rimraf ./dist ./coverage ./node_modules"