cacheable 2.0.0 → 2.0.2

package/dist/index.js

@@ -1 +1,957 @@
-import{getOrSet as v,wrap as A}from"@cacheable/memoize";import{createKeyv as w}from"@cacheable/memory";import{Stats as O,calculateTtlFromExpiration as p,getCascadingTtl as u,HashAlgorithm as R,hash as M,shorthandToMilliseconds as g}from"@cacheable/utils";import{Hookified as b}from"hookified";import{Keyv as f}from"keyv";var m=(o=>(o.BEFORE_SET="BEFORE_SET",o.AFTER_SET="AFTER_SET",o.BEFORE_SET_MANY="BEFORE_SET_MANY",o.AFTER_SET_MANY="AFTER_SET_MANY",o.BEFORE_GET="BEFORE_GET",o.AFTER_GET="AFTER_GET",o.BEFORE_GET_MANY="BEFORE_GET_MANY",o.AFTER_GET_MANY="AFTER_GET_MANY",o.BEFORE_SECONDARY_SETS_PRIMARY="BEFORE_SECONDARY_SETS_PRIMARY",o))(m||{}),E=(e=>(e.ERROR="error",e.CACHE_HIT="cache:hit",e.CACHE_MISS="cache:miss",e))(E||{});import{getOrSet as D,wrap as H,wrapSync as z}from"@cacheable/memoize";import{CacheableMemory as W,createKeyv as j,KeyvCacheableMemory as q}from"@cacheable/memory";import{calculateTtlFromExpiration as L,getCascadingTtl as Q,HashAlgorithm as U,hash as X,Stats as Z,shorthandToMilliseconds as $,shorthandToTime as tt}from"@cacheable/utils";import{Keyv as st,KeyvHooks as it}from"keyv";var T=class extends b{_primary=w();_secondary;_nonBlocking=!1;_ttl;_stats=new O({enabled:!1});_namespace;_cacheId=Math.random().toString(36).slice(2);constructor(t){super(),t?.primary&&this.setPrimary(t.primary),t?.secondary&&this.setSecondary(t.secondary),t?.nonBlocking&&(this._nonBlocking=t.nonBlocking),t?.stats&&(this._stats.enabled=t.stats),t?.ttl&&this.setTtl(t.ttl),t?.cacheId&&(this._cacheId=t.cacheId),t?.namespace&&(this._namespace=t.namespace,this._primary.namespace=this.getNameSpace(),this._secondary&&(this._secondary.namespace=this.getNameSpace()))}get namespace(){return this._namespace}set namespace(t){this._namespace=t,this._primary.namespace=this.getNameSpace(),this._secondary&&(this._secondary.namespace=this.getNameSpace())}get stats(){return this._stats}get primary(){return this._primary}set primary(t){this._primary=t}get secondary(){return this._secondary}set secondary(t){this._secondary=t}get nonBlocking(){return this._nonBlocking}set nonBlocking(t){this._nonBlocking=t}get ttl(){return this._ttl}set ttl(t){this.setTtl(t)}get cacheId(){return this._cacheId}set cacheId(t){this._cacheId=t}setPrimary(t){this.isKeyvInstance(t)?this._primary=t:this._primary=new f(t),this._primary.on("error",s=>{this.emit("error",s)})}setSecondary(t){this.isKeyvInstance(t)?this._secondary=t:this._secondary=new f(t),this._secondary.on("error",s=>{this.emit("error",s)})}isKeyvInstance(t){return t instanceof f?!0:["generateIterator","get","getMany","set","setMany","delete","deleteMany","has","hasMany","clear","disconnect","serialize","deserialize"].every(e=>typeof t[e]=="function")}getNameSpace(){return typeof this._namespace=="function"?this._namespace():this._namespace}async get(t,s){return(await this.getRaw(t,s))?.value}async getRaw(t,s){let e;try{await this.hook("BEFORE_GET",t),e=await this._primary.getRaw(t);let i;e?this.emit("cache:hit",{key:t,value:e.value,store:"primary"}):this.emit("cache:miss",{key:t,store:"primary"});let n=s?.nonBlocking??this._nonBlocking;if(!e&&this._secondary){let a;n?a=await this.processSecondaryForGetRawNonBlocking(this._primary,this._secondary,t):a=await this.processSecondaryForGetRaw(this._primary,this._secondary,t),a&&(e=a.result,i=a.ttl)}await this.hook("AFTER_GET",{key:t,result:e,ttl:i})}catch(i){this.emit("error",i)}return this.stats.enabled&&(e?this._stats.incrementHits():this._stats.incrementMisses(),this.stats.incrementGets()),e}async getManyRaw(t,s){let e=[];try{await this.hook("BEFORE_GET_MANY",t),e=await this._primary.getManyRaw(t);for(let[n,a]of t.entries())e[n]?this.emit("cache:hit",{key:a,value:e[n].value,store:"primary"}):this.emit("cache:miss",{key:a,store:"primary"});let i=s?.nonBlocking??this._nonBlocking;this._secondary&&(i?await this.processSecondaryForGetManyRawNonBlocking(this._primary,this._secondary,t,e):await this.processSecondaryForGetManyRaw(this._primary,this._secondary,t,e)),await this.hook("AFTER_GET_MANY",{keys:t,result:e})}catch(i){this.emit("error",i)}if(this.stats.enabled){for(let i of e)i?this._stats.incrementHits():this._stats.incrementMisses();this.stats.incrementGets()}return e}async getMany(t,s){return(await this.getManyRaw(t,s)).map(i=>i?.value)}async set(t,s,e){let i=!1,n=g(e??this._ttl);try{let a={key:t,value:s,ttl:n};await this.hook("BEFORE_SET",a);let r=[];if(r.push(this._primary.set(a.key,a.value,a.ttl)),this._secondary&&r.push(this._secondary.set(a.key,a.value,a.ttl)),this._nonBlocking){i=await Promise.race(r);for(let c of r)c.catch(o=>{this.emit("error",o)})}else i=(await Promise.all(r))[0];await this.hook("AFTER_SET",a)}catch(a){this.emit("error",a)}return this.stats.enabled&&(this.stats.incrementKSize(t),this.stats.incrementCount(),this.stats.incrementVSize(s),this.stats.incrementSets()),i}async setMany(t){let s=!1;try{await this.hook("BEFORE_SET_MANY",t),s=await this.setManyKeyv(this._primary,t),this._secondary&&(this._nonBlocking?this.setManyKeyv(this._secondary,t).catch(e=>{this.emit("error",e)}):await this.setManyKeyv(this._secondary,t)),await this.hook("AFTER_SET_MANY",t)}catch(e){this.emit("error",e)}if(this.stats.enabled)for(let e of t)this.stats.incrementKSize(e.key),this.stats.incrementCount(),this.stats.incrementVSize(e.value);return s}async take(t){let s=await this.get(t);return await this.delete(t),s}async takeMany(t){let s=await this.getMany(t);return await this.deleteMany(t),s}async has(t){let s=[];s.push(this._primary.has(t)),this._secondary&&s.push(this._secondary.has(t));let e=await Promise.all(s);for(let i of e)if(i)return!0;return!1}async hasMany(t){let s=await this.hasManyKeyv(this._primary,t),e=[];for(let[i,n]of t.entries())!s[i]&&this._secondary&&e.push(n);if(e.length>0&&this._secondary){let i=await this.hasManyKeyv(this._secondary,t);for(let[n,a]of t.entries())!s[n]&&i[n]&&(s[n]=i[n])}return s}async delete(t){let s=!1,e=[];if(this.stats.enabled){let i=await this._primary.get(t);i&&(this.stats.decreaseKSize(t),this.stats.decreaseVSize(i),this.stats.decreaseCount(),this.stats.incrementDeletes())}if(e.push(this._primary.delete(t)),this._secondary&&e.push(this._secondary.delete(t)),this.nonBlocking){s=await Promise.race(e);for(let i of e)i.catch(n=>{this.emit("error",n)})}else s=(await Promise.all(e))[0];return s}async deleteMany(t){if(this.stats.enabled){let e=await this._primary.get(t);for(let i of t)this.stats.decreaseKSize(i),this.stats.decreaseVSize(e),this.stats.decreaseCount(),this.stats.incrementDeletes()}let s=await this._primary.deleteMany(t);return this._secondary&&(this._nonBlocking?this._secondary.deleteMany(t).catch(e=>{this.emit("error",e)}):await this._secondary.deleteMany(t)),s}async clear(){let t=[];t.push(this._primary.clear()),this._secondary&&t.push(this._secondary.clear()),await(this._nonBlocking?Promise.race(t):Promise.all(t)),this.stats.enabled&&(this._stats.resetStoreValues(),this._stats.incrementClears())}async disconnect(){let t=[];t.push(this._primary.disconnect()),this._secondary&&t.push(this._secondary.disconnect()),await(this._nonBlocking?Promise.race(t):Promise.all(t))}wrap(t,s){let e={get:async n=>this.get(n),has:async n=>this.has(n),set:async(n,a,r)=>{await this.set(n,a,r)},on:(n,a)=>{this.on(n,a)},emit:(n,...a)=>this.emit(n,...a)},i={ttl:s?.ttl??this._ttl,keyPrefix:s?.keyPrefix,createKey:s?.createKey,cacheErrors:s?.cacheErrors,cache:e,cacheId:this._cacheId,serialize:s?.serialize};return A(t,i)}async getOrSet(t,s,e){let n={cache:{get:async a=>this.get(a),has:async a=>this.has(a),set:async(a,r,c)=>{await this.set(a,r,c)},on:(a,r)=>{this.on(a,r)},emit:(a,...r)=>this.emit(a,...r)},cacheId:this._cacheId,ttl:e?.ttl??this._ttl,cacheErrors:e?.cacheErrors,throwErrors:e?.throwErrors};return v(t,s,n)}hash(t,s=R.SHA256){let e=Object.values(R).includes(s)?s:R.SHA256;return M(t,{algorithm:e})}async setManyKeyv(t,s){let e=[];for(let i of s){let n=g(i.ttl??this._ttl);e.push({key:i.key,value:i.value,ttl:n})}return await t.setMany(e),!0}async hasManyKeyv(t,s){let e=[];for(let i of s)e.push(t.has(i));return Promise.all(e)}async processSecondaryForGetRaw(t,s,e){let i=await s.getRaw(e);if(i?.value){this.emit("cache:hit",{key:e,value:i.value,store:"secondary"});let n=u(this._ttl,this._primary.ttl),a=i.expires??void 0,r=p(n,a),c={key:e,value:i.value,ttl:r};return await this.hook("BEFORE_SECONDARY_SETS_PRIMARY",c),await t.set(c.key,c.value,c.ttl),{result:i,ttl:r}}else{this.emit("cache:miss",{key:e,store:"secondary"});return}}async processSecondaryForGetRawNonBlocking(t,s,e){let i=await s.getRaw(e);if(i?.value){this.emit("cache:hit",{key:e,value:i.value,store:"secondary"});let n=u(this._ttl,this._primary.ttl),a=i.expires??void 0,r=p(n,a),c={key:e,value:i.value,ttl:r};return this.hook("BEFORE_SECONDARY_SETS_PRIMARY",c).then(async()=>{await t.set(c.key,c.value,c.ttl)}).catch(o=>{this.emit("error",o)}),{result:i,ttl:r}}else{this.emit("cache:miss",{key:e,store:"secondary"});return}}async processSecondaryForGetManyRaw(t,s,e,i){let n=[];for(let[c,o]of e.entries())i[c]||n.push(o);let a=await s.getManyRaw(n),r=0;for await(let[c,o]of e.entries())if(!i[c]){let l=a[r];if(l&&l.value!==void 0){i[c]=l,this.emit("cache:hit",{key:o,value:l.value,store:"secondary"});let d=u(this._ttl,this._primary.ttl),{expires:y}=l;y===null&&(y=void 0);let _=p(d,y),h={key:o,value:l.value,ttl:_};await this.hook("BEFORE_SECONDARY_SETS_PRIMARY",h),await t.set(h.key,h.value,h.ttl)}else this.emit("cache:miss",{key:o,store:"secondary"});r++}}async processSecondaryForGetManyRawNonBlocking(t,s,e,i){let n=[];for(let[c,o]of e.entries())i[c]||n.push(o);let a=await s.getManyRaw(n),r=0;for await(let[c,o]of e.entries())if(!i[c]){let l=a[r];if(l&&l.value!==void 0){i[c]=l,this.emit("cache:hit",{key:o,value:l.value,store:"secondary"});let d=u(this._ttl,this._primary.ttl),{expires:y}=l;y===null&&(y=void 0);let _=p(d,y),h={key:o,value:l.value,ttl:_};this.hook("BEFORE_SECONDARY_SETS_PRIMARY",h).then(async()=>{await t.set(h.key,h.value,h.ttl)}).catch(S=>{this.emit("error",S)})}else this.emit("cache:miss",{key:o,store:"secondary"});r++}}setTtl(t){typeof t=="string"||t===void 0?this._ttl=t:t>0?this._ttl=t:this._ttl=void 0}};export{T as Cacheable,E as CacheableEvents,m as CacheableHooks,W as CacheableMemory,Z as CacheableStats,U as HashAlgorithm,st as Keyv,q as KeyvCacheableMemory,it as KeyvHooks,L as calculateTtlFromExpiration,j as createKeyv,Q as getCascadingTtl,D as getOrSet,X as hash,$ as shorthandToMilliseconds,tt as shorthandToTime,H as wrap,z as wrapSync};
+// src/index.ts
+import {
+  getOrSet,
+  wrap
+} from "@cacheable/memoize";
+import { createKeyv } from "@cacheable/memory";
+import {
+  Stats as CacheableStats,
+  calculateTtlFromExpiration,
+  getCascadingTtl,
+  HashAlgorithm,
+  hash,
+  shorthandToMilliseconds
+} from "@cacheable/utils";
+import { Hookified } from "hookified";
+import {
+  Keyv
+} from "keyv";
+
+// src/enums.ts
+var CacheableHooks = /* @__PURE__ */ ((CacheableHooks2) => {
+  CacheableHooks2["BEFORE_SET"] = "BEFORE_SET";
+  CacheableHooks2["AFTER_SET"] = "AFTER_SET";
+  CacheableHooks2["BEFORE_SET_MANY"] = "BEFORE_SET_MANY";
+  CacheableHooks2["AFTER_SET_MANY"] = "AFTER_SET_MANY";
+  CacheableHooks2["BEFORE_GET"] = "BEFORE_GET";
+  CacheableHooks2["AFTER_GET"] = "AFTER_GET";
+  CacheableHooks2["BEFORE_GET_MANY"] = "BEFORE_GET_MANY";
+  CacheableHooks2["AFTER_GET_MANY"] = "AFTER_GET_MANY";
+  CacheableHooks2["BEFORE_SECONDARY_SETS_PRIMARY"] = "BEFORE_SECONDARY_SETS_PRIMARY";
+  return CacheableHooks2;
+})(CacheableHooks || {});
+var CacheableEvents = /* @__PURE__ */ ((CacheableEvents2) => {
+  CacheableEvents2["ERROR"] = "error";
+  CacheableEvents2["CACHE_HIT"] = "cache:hit";
+  CacheableEvents2["CACHE_MISS"] = "cache:miss";
+  return CacheableEvents2;
+})(CacheableEvents || {});
+
+// src/index.ts
+import {
+  getOrSet as getOrSet2,
+  wrap as wrap2,
+  wrapSync
+} from "@cacheable/memoize";
+import {
+  CacheableMemory,
+  createKeyv as createKeyv2,
+  KeyvCacheableMemory
+} from "@cacheable/memory";
+import {
+  calculateTtlFromExpiration as calculateTtlFromExpiration2,
+  getCascadingTtl as getCascadingTtl2,
+  HashAlgorithm as HashAlgorithm2,
+  hash as hash2,
+  Stats,
+  shorthandToMilliseconds as shorthandToMilliseconds2,
+  shorthandToTime
+} from "@cacheable/utils";
+import { Keyv as Keyv2, KeyvHooks } from "keyv";
+var Cacheable = class extends Hookified {
+  _primary = createKeyv();
+  _secondary;
+  _nonBlocking = false;
+  _ttl;
+  _stats = new CacheableStats({ enabled: false });
+  _namespace;
+  _cacheId = Math.random().toString(36).slice(2);
+  /**
+   * Creates a new cacheable instance
+   * @param {CacheableOptions} [options] The options for the cacheable instance
+   */
+  constructor(options) {
+    super();
+    if (options?.primary) {
+      this.setPrimary(options.primary);
+    }
+    if (options?.secondary) {
+      this.setSecondary(options.secondary);
+    }
+    if (options?.nonBlocking) {
+      this._nonBlocking = options.nonBlocking;
+    }
+    if (options?.stats) {
+      this._stats.enabled = options.stats;
+    }
+    if (options?.ttl) {
+      this.setTtl(options.ttl);
+    }
+    if (options?.cacheId) {
+      this._cacheId = options.cacheId;
+    }
+    if (options?.namespace) {
+      this._namespace = options.namespace;
+      this._primary.namespace = this.getNameSpace();
+      if (this._secondary) {
+        this._secondary.namespace = this.getNameSpace();
+      }
+    }
+  }
+  /**
+   * The namespace for the cacheable instance
+   * @returns {string | (() => string) | undefined} The namespace for the cacheable instance
+   */
+  get namespace() {
+    return this._namespace;
+  }
+  /**
+   * Sets the namespace for the cacheable instance
+   * @param {string | (() => string) | undefined} namespace The namespace for the cacheable instance
+   * @returns {void}
+   */
+  set namespace(namespace) {
+    this._namespace = namespace;
+    this._primary.namespace = this.getNameSpace();
+    if (this._secondary) {
+      this._secondary.namespace = this.getNameSpace();
+    }
+  }
+  /**
+   * The statistics for the cacheable instance
+   * @returns {CacheableStats} The statistics for the cacheable instance
+   */
+  get stats() {
+    return this._stats;
+  }
+  /**
+   * The primary store for the cacheable instance
+   * @returns {Keyv} The primary store for the cacheable instance
+   */
+  get primary() {
+    return this._primary;
+  }
+  /**
+   * Sets the primary store for the cacheable instance
+   * @param {Keyv} primary The primary store for the cacheable instance
+   */
+  set primary(primary) {
+    this._primary = primary;
+  }
+  /**
+   * The secondary store for the cacheable instance
+   * @returns {Keyv | undefined} The secondary store for the cacheable instance
+   */
+  get secondary() {
+    return this._secondary;
+  }
+  /**
+   * Sets the secondary store for the cacheable instance. If it is set to undefined then the secondary store is disabled.
+   * @param {Keyv | undefined} secondary The secondary store for the cacheable instance
+   * @returns {void}
+   */
+  set secondary(secondary) {
+    this._secondary = secondary;
+  }
+  /**
+   * Gets whether the secondary store is non-blocking mode. It is set to false by default.
+   * If it is set to true then the secondary store will not block the primary store.
+   *
+   * [Learn more about non-blocking mode](https://cacheable.org/docs/cacheable/#non-blocking-operations).
+   *
+   * @returns {boolean} Whether the cacheable instance is non-blocking
+   */
+  get nonBlocking() {
+    return this._nonBlocking;
+  }
+  /**
+   * Sets whether the secondary store is non-blocking mode. It is set to false by default.
+   * If it is set to true then the secondary store will not block the primary store.
+   *
+   * [Learn more about non-blocking mode](https://cacheable.org/docs/cacheable/#non-blocking-operations).
+   *
+   * @param {boolean} nonBlocking Whether the cacheable instance is non-blocking
+   * @returns {void}
+   */
+  set nonBlocking(nonBlocking) {
+    this._nonBlocking = nonBlocking;
+  }
+  /**
+   * The time-to-live for the cacheable instance and will be used as the default value.
+   * can be a number in milliseconds or a human-readable format such as `1s` for 1 second or `1h` for 1 hour
+   * or undefined if there is no time-to-live.
+   *
+   * [Learn more about time-to-live](https://cacheable.org/docs/cacheable/#shorthand-for-time-to-live-ttl).
+   *
+   * @returns {number | string | undefined} The time-to-live for the cacheable instance in milliseconds, human-readable format or undefined
+   * @example
+   * ```typescript
+   * const cacheable = new Cacheable({ ttl: '1h' });
+   * console.log(cacheable.ttl); // 1h
+   * ```
+   */
+  get ttl() {
+    return this._ttl;
+  }
+  /**
+   * Sets the time-to-live for the cacheable instance and will be used as the default value.
+   * If you set a number it is miliseconds, if you set a string it is a human-readable
+   * format such as `1s` for 1 second or `1h` for 1 hour. Setting undefined means that
+   * there is no time-to-live.
+   *
+   * [Learn more about time-to-live](https://cacheable.org/docs/cacheable/#shorthand-for-time-to-live-ttl).
+   *
+   * @param {number | string | undefined} ttl The time-to-live for the cacheable instance
+   * @example
+   * ```typescript
+   * const cacheable = new Cacheable();
+   * cacheable.ttl = '1h'; // Set the time-to-live to 1 hour
+   * ```
+   * or setting the time-to-live in milliseconds
+   * ```typescript
+   * const cacheable = new Cacheable();
+   * cacheable.ttl = 3600000; // Set the time-to-live to 1 hour
+   * ```
+   */
+  set ttl(ttl) {
+    this.setTtl(ttl);
+  }
+  /**
+   * The cacheId for the cacheable instance. This is primarily used for the wrap function to not have conflicts.
+   * If it is not set then it will be a random string that is generated
+   * @returns {string} The cacheId for the cacheable instance
+   */
+  get cacheId() {
+    return this._cacheId;
+  }
+  /**
+   * Sets the cacheId for the cacheable instance. This is primarily used for the wrap function to not have conflicts.
+   * If it is not set then it will be a random string that is generated
+   * @param {string} cacheId The cacheId for the cacheable instance
+   */
+  set cacheId(cacheId) {
+    this._cacheId = cacheId;
+  }
+  /**
+   * Sets the primary store for the cacheable instance
+   * @param {Keyv | KeyvStoreAdapter} primary The primary store for the cacheable instance
+   * @returns {void}
+   */
+  setPrimary(primary) {
+    if (this.isKeyvInstance(primary)) {
+      this._primary = primary;
+    } else {
+      this._primary = new Keyv(primary);
+    }
+    this._primary.on("error", (error) => {
+      this.emit("error" /* ERROR */, error);
+    });
+  }
+  /**
+   * Sets the secondary store for the cacheable instance. If it is set to undefined then the secondary store is disabled.
+   * @param {Keyv | KeyvStoreAdapter} secondary The secondary store for the cacheable instance
+   * @returns {void}
+   */
+  setSecondary(secondary) {
+    if (this.isKeyvInstance(secondary)) {
+      this._secondary = secondary;
+    } else {
+      this._secondary = new Keyv(secondary);
+    }
+    this._secondary.on("error", (error) => {
+      this.emit("error" /* ERROR */, error);
+    });
+  }
+  // biome-ignore lint/suspicious/noExplicitAny: type format
+  isKeyvInstance(keyv) {
+    if (keyv instanceof Keyv) {
+      return true;
+    }
+    const keyvMethods = [
+      "generateIterator",
+      "get",
+      "getMany",
+      "set",
+      "setMany",
+      "delete",
+      "deleteMany",
+      "has",
+      "hasMany",
+      "clear",
+      "disconnect",
+      "serialize",
+      "deserialize"
+    ];
+    return keyvMethods.every((method) => typeof keyv[method] === "function");
+  }
+  getNameSpace() {
+    if (typeof this._namespace === "function") {
+      return this._namespace();
+    }
+    return this._namespace;
+  }
+  /**
+   * Retrieves an entry from the cache.
+   *
+   * Checks the primary store first; if not found and a secondary store is configured,
+   * it will fetch from the secondary, repopulate the primary, and return the result.
+   *
+   * @typeParam T - The expected type of the stored value.
+   * @param {string} key - The cache key to retrieve.
+   * @param {GetOptions} - options such as to bypass `nonBlocking` for this call
+   * @returns {Promise<T | undefined>}
+   *   A promise that resolves to the cached value if found, or `undefined`.
+   */
+  async get(key, options) {
+    const result = await this.getRaw(key, options);
+    return result?.value;
+  }
+  /**
+   * Retrieves the raw entry from the cache including metadata like expiration.
+   *
+   * Checks the primary store first; if not found and a secondary store is configured,
+   * it will fetch from the secondary, repopulate the primary, and return the result.
+   *
+   * @typeParam T - The expected type of the stored value.
+   * @param {string} key - The cache key to retrieve.
+   * @param {GetOptions} - options such as to bypass `nonBlocking` for this call
+   * @returns {Promise<StoredDataRaw<T>>}
+   *   A promise that resolves to the full raw data object if found, or undefined.
+   */
+  async getRaw(key, options) {
+    let result;
+    try {
+      await this.hook("BEFORE_GET" /* BEFORE_GET */, key);
+      result = await this._primary.getRaw(key);
+      let ttl;
+      if (result) {
+        this.emit("cache:hit" /* CACHE_HIT */, {
+          key,
+          value: result.value,
+          store: "primary"
+        });
+      } else {
+        this.emit("cache:miss" /* CACHE_MISS */, { key, store: "primary" });
+      }
+      const nonBlocking = options?.nonBlocking ?? this._nonBlocking;
+      if (!result && this._secondary) {
+        let secondaryProcessResult;
+        if (nonBlocking) {
+          secondaryProcessResult = await this.processSecondaryForGetRawNonBlocking(
+            this._primary,
+            this._secondary,
+            key
+          );
+        } else {
+          secondaryProcessResult = await this.processSecondaryForGetRaw(
+            this._primary,
+            this._secondary,
+            key
+          );
+        }
+        if (secondaryProcessResult) {
+          result = secondaryProcessResult.result;
+          ttl = secondaryProcessResult.ttl;
+        }
+      }
+      await this.hook("AFTER_GET" /* AFTER_GET */, { key, result, ttl });
+    } catch (error) {
+      this.emit("error" /* ERROR */, error);
+    }
+    if (this.stats.enabled) {
+      if (result) {
+        this._stats.incrementHits();
+      } else {
+        this._stats.incrementMisses();
+      }
+      this.stats.incrementGets();
+    }
+    return result;
+  }
+  /**
+   * Retrieves multiple raw entries from the cache including metadata like expiration.
+   *
+   * Checks the primary store for each key; if a key is missing and a secondary store is configured,
+   * it will fetch from the secondary store, repopulate the primary store, and return the results.
+   *
+   * @typeParam T - The expected type of the stored values.
+   * @param {string[]} keys - The cache keys to retrieve.
+   * @param {GetOptions} - options such as to bypass `nonBlocking` on this call
+   * @returns {Promise<Array<StoredDataRaw<T>>>}
+   *   A promise that resolves to an array of raw data objects.
+   */
+  async getManyRaw(keys, options) {
+    let result = [];
+    try {
+      await this.hook("BEFORE_GET_MANY" /* BEFORE_GET_MANY */, keys);
+      result = await this._primary.getManyRaw(keys);
+      for (const [i, key] of keys.entries()) {
+        if (result[i]) {
+          this.emit("cache:hit" /* CACHE_HIT */, {
+            key,
+            value: result[i].value,
+            store: "primary"
+          });
+        } else {
+          this.emit("cache:miss" /* CACHE_MISS */, { key, store: "primary" });
+        }
+      }
+      const nonBlocking = options?.nonBlocking ?? this._nonBlocking;
+      if (this._secondary) {
+        if (nonBlocking) {
+          await this.processSecondaryForGetManyRawNonBlocking(
+            this._primary,
+            this._secondary,
+            keys,
+            result
+          );
+        } else {
+          await this.processSecondaryForGetManyRaw(
+            this._primary,
+            this._secondary,
+            keys,
+            result
+          );
+        }
+      }
+      await this.hook("AFTER_GET_MANY" /* AFTER_GET_MANY */, { keys, result });
+    } catch (error) {
+      this.emit("error" /* ERROR */, error);
+    }
+    if (this.stats.enabled) {
+      for (const item of result) {
+        if (item) {
+          this._stats.incrementHits();
+        } else {
+          this._stats.incrementMisses();
+        }
+      }
+      this.stats.incrementGets();
+    }
+    return result;
+  }
+  /**
+   * Retrieves multiple entries from the cache.
+   * Checks the primary store for each key; if a key is missing and a secondary store is configured,
+   * it will fetch from the secondary store, repopulate the primary store, and return the results.
+   *
+   * @typeParam T - The expected type of the stored values.
+   * @param {string[]} keys - The cache keys to retrieve.
+   * @param {GetOptions} - options such as to bypass `nonBlocking` on this call
+   * @returns {Promise<Array<T | undefined>>}
+   *   A promise that resolves to an array of cached values or `undefined` for misses.
+   */
+  async getMany(keys, options) {
+    const result = await this.getManyRaw(keys, options);
+    return result.map((item) => item?.value);
+  }
+  /**
+   * Sets the value of the key. If the secondary store is set then it will also set the value in the secondary store.
+   * @param {string} key the key to set the value of
+   * @param {T} value The value to set
+   * @param {number | string} [ttl] set a number it is miliseconds, set a string it is a human-readable
+   * format such as `1s` for 1 second or `1h` for 1 hour. Setting undefined means that it will use the default time-to-live.
+   * @returns {boolean} Whether the value was set
+   */
+  async set(key, value, ttl) {
+    let result = false;
+    const finalTtl = shorthandToMilliseconds(ttl ?? this._ttl);
+    try {
+      const item = { key, value, ttl: finalTtl };
+      await this.hook("BEFORE_SET" /* BEFORE_SET */, item);
+      const promises = [];
+      promises.push(this._primary.set(item.key, item.value, item.ttl));
+      if (this._secondary) {
+        promises.push(this._secondary.set(item.key, item.value, item.ttl));
+      }
+      if (this._nonBlocking) {
+        result = await Promise.race(promises);
+        for (const promise of promises) {
+          promise.catch((error) => {
+            this.emit("error" /* ERROR */, error);
+          });
+        }
+      } else {
+        const results = await Promise.all(promises);
+        result = results[0];
+      }
+      await this.hook("AFTER_SET" /* AFTER_SET */, item);
+    } catch (error) {
+      this.emit("error" /* ERROR */, error);
+    }
+    if (this.stats.enabled) {
+      this.stats.incrementKSize(key);
+      this.stats.incrementCount();
+      this.stats.incrementVSize(value);
+      this.stats.incrementSets();
+    }
+    return result;
+  }
+  /**
+   * Sets the values of the keys. If the secondary store is set then it will also set the values in the secondary store.
+   * @param {CacheableItem[]} items The items to set
+   * @returns {boolean} Whether the values were set
+   */
+  async setMany(items) {
+    let result = false;
+    try {
+      await this.hook("BEFORE_SET_MANY" /* BEFORE_SET_MANY */, items);
+      result = await this.setManyKeyv(this._primary, items);
+      if (this._secondary) {
+        if (this._nonBlocking) {
+          this.setManyKeyv(this._secondary, items).catch((error) => {
+            this.emit("error" /* ERROR */, error);
+          });
+        } else {
+          await this.setManyKeyv(this._secondary, items);
+        }
+      }
+      await this.hook("AFTER_SET_MANY" /* AFTER_SET_MANY */, items);
+    } catch (error) {
+      this.emit("error" /* ERROR */, error);
+    }
+    if (this.stats.enabled) {
+      for (const item of items) {
+        this.stats.incrementKSize(item.key);
+        this.stats.incrementCount();
+        this.stats.incrementVSize(item.value);
+      }
+    }
+    return result;
+  }
+  /**
+   * Takes the value of the key and deletes the key. If the key does not exist then it will return undefined.
+   * @param {string} key The key to take the value of
+   * @returns {Promise<T | undefined>} The value of the key or undefined if the key does not exist
+   */
+  async take(key) {
+    const result = await this.get(key);
+    await this.delete(key);
+    return result;
+  }
+  /**
+   * Takes the values of the keys and deletes the keys. If the key does not exist then it will return undefined.
+   * @param {string[]} keys The keys to take the values of
+   * @returns {Promise<Array<T | undefined>>} The values of the keys or undefined if the key does not exist
+   */
+  async takeMany(keys) {
+    const result = await this.getMany(keys);
+    await this.deleteMany(keys);
+    return result;
+  }
+  /**
+   * Checks if the key exists in the primary store. If it does not exist then it will check the secondary store.
+   * @param {string} key The key to check
+   * @returns {Promise<boolean>} Whether the key exists
+   */
+  async has(key) {
+    const promises = [];
+    promises.push(this._primary.has(key));
+    if (this._secondary) {
+      promises.push(this._secondary.has(key));
+    }
+    const resultAll = await Promise.all(promises);
+    for (const result of resultAll) {
+      if (result) {
+        return true;
+      }
+    }
+    return false;
+  }
+  /**
+   * Checks if the keys exist in the primary store. If it does not exist then it will check the secondary store.
+   * @param {string[]} keys The keys to check
+   * @returns {Promise<boolean[]>} Whether the keys exist
+   */
+  async hasMany(keys) {
+    const result = await this.hasManyKeyv(this._primary, keys);
+    const missingKeys = [];
+    for (const [i, key] of keys.entries()) {
+      if (!result[i] && this._secondary) {
+        missingKeys.push(key);
+      }
+    }
+    if (missingKeys.length > 0 && this._secondary) {
+      const secondary = await this.hasManyKeyv(this._secondary, keys);
+      for (const [i, _key] of keys.entries()) {
+        if (!result[i] && secondary[i]) {
+          result[i] = secondary[i];
+        }
+      }
+    }
+    return result;
+  }
+  /**
+   * Deletes the key from the primary store. If the secondary store is set then it will also delete the key from the secondary store.
+   * @param {string} key The key to delete
+   * @returns {Promise<boolean>} Whether the key was deleted
+   */
+  async delete(key) {
+    let result = false;
+    const promises = [];
+    if (this.stats.enabled) {
+      const statResult = await this._primary.get(key);
+      if (statResult) {
+        this.stats.decreaseKSize(key);
+        this.stats.decreaseVSize(statResult);
+        this.stats.decreaseCount();
+        this.stats.incrementDeletes();
+      }
+    }
+    promises.push(this._primary.delete(key));
+    if (this._secondary) {
+      promises.push(this._secondary.delete(key));
+    }
+    if (this.nonBlocking) {
+      result = await Promise.race(promises);
+      for (const promise of promises) {
+        promise.catch((error) => {
+          this.emit("error" /* ERROR */, error);
+        });
+      }
+    } else {
+      const resultAll = await Promise.all(promises);
+      result = resultAll[0];
+    }
+    return result;
+  }
+  /**
+   * Deletes the keys from the primary store. If the secondary store is set then it will also delete the keys from the secondary store.
+   * @param {string[]} keys The keys to delete
+   * @returns {Promise<boolean>} Whether the keys were deleted
+   */
+  async deleteMany(keys) {
+    if (this.stats.enabled) {
+      const statResult = await this._primary.get(keys);
+      for (const key of keys) {
+        this.stats.decreaseKSize(key);
+        this.stats.decreaseVSize(statResult);
+        this.stats.decreaseCount();
+        this.stats.incrementDeletes();
+      }
+    }
+    const result = await this._primary.deleteMany(keys);
+    if (this._secondary) {
+      if (this._nonBlocking) {
+        this._secondary.deleteMany(keys).catch((error) => {
+          this.emit("error" /* ERROR */, error);
+        });
+      } else {
+        await this._secondary.deleteMany(keys);
+      }
+    }
+    return result;
+  }
+  /**
+   * Clears the primary store. If the secondary store is set then it will also clear the secondary store.
+   * @returns {Promise<void>}
+   */
+  async clear() {
+    const promises = [];
+    promises.push(this._primary.clear());
+    if (this._secondary) {
+      promises.push(this._secondary.clear());
+    }
+    await (this._nonBlocking ? Promise.race(promises) : Promise.all(promises));
+    if (this.stats.enabled) {
+      this._stats.resetStoreValues();
+      this._stats.incrementClears();
+    }
+  }
+  /**
+   * Disconnects the primary store. If the secondary store is set then it will also disconnect the secondary store.
+   * @returns {Promise<void>}
+   */
+  async disconnect() {
+    const promises = [];
+    promises.push(this._primary.disconnect());
+    if (this._secondary) {
+      promises.push(this._secondary.disconnect());
+    }
+    await (this._nonBlocking ? Promise.race(promises) : Promise.all(promises));
+  }
+  /**
+   * Wraps a function with caching
+   *
+   * [Learn more about wrapping functions](https://cacheable.org/docs/cacheable/#wrap--memoization-for-sync-and-async-functions).
+   * @param {Function} function_ The function to wrap
+   * @param {WrapOptions} [options] The options for the wrap function
+   * @returns {Function} The wrapped function
+   */
+  // biome-ignore lint/suspicious/noExplicitAny: type format
+  wrap(function_, options) {
+    const cacheAdapter = {
+      get: async (key) => this.get(key),
+      has: async (key) => this.has(key),
+      // biome-ignore lint/suspicious/noExplicitAny: CacheInstance requires any type
+      set: async (key, value, ttl) => {
+        await this.set(key, value, ttl);
+      },
+      /* c8 ignore start */
+      // biome-ignore lint/suspicious/noExplicitAny: CacheInstance interface
+      on: (event, listener) => {
+        this.on(event, listener);
+      },
+      /* c8 ignore stop */
+      // biome-ignore lint/suspicious/noExplicitAny: CacheInstance requires any type
+      emit: (event, ...args) => this.emit(event, ...args)
+    };
+    const wrapOptions = {
+      ttl: options?.ttl ?? this._ttl,
+      keyPrefix: options?.keyPrefix,
+      createKey: options?.createKey,
+      cacheErrors: options?.cacheErrors,
+      cache: cacheAdapter,
+      cacheId: this._cacheId,
+      serialize: options?.serialize
+    };
+    return wrap(function_, wrapOptions);
+  }
+  /**
+   * Retrieves the value associated with the given key from the cache. If the key is not found,
+   * invokes the provided function to calculate the value, stores it in the cache, and then returns it.
+   *
+   * @param {GetOrSetKey} key - The key to retrieve or set in the cache. This can also be a function that returns a string key.
+   * If a function is provided, it will be called with the cache options to generate the key.
+   * @param {() => Promise<T>} function_ - The asynchronous function that computes the value to be cached if the key does not exist.
+   * @param {GetOrSetFunctionOptions} [options] - Optional settings for caching, such as the time to live (TTL) or whether to cache errors.
+   * @return {Promise<T | undefined>} - A promise that resolves to the cached or newly computed value, or undefined if an error occurs and caching is not configured for errors.
+   */
+  async getOrSet(key, function_, options) {
+    const cacheAdapter = {
+      get: async (key2) => this.get(key2),
+      has: async (key2) => this.has(key2),
+      // biome-ignore lint/suspicious/noExplicitAny: CacheInstance requires any type
+      set: async (key2, value, ttl) => {
+        await this.set(key2, value, ttl);
+      },
+      /* c8 ignore start */
+      // biome-ignore lint/suspicious/noExplicitAny: CacheInstance interface
+      on: (event, listener) => {
+        this.on(event, listener);
+      },
+      /* c8 ignore stop */
+      // biome-ignore lint/suspicious/noExplicitAny: CacheInstance requires any type
+      emit: (event, ...args) => this.emit(event, ...args)
+    };
+    const getOrSetOptions = {
+      cache: cacheAdapter,
+      cacheId: this._cacheId,
+      ttl: options?.ttl ?? this._ttl,
+      cacheErrors: options?.cacheErrors,
+      throwErrors: options?.throwErrors
+    };
+    return getOrSet(key, function_, getOrSetOptions);
+  }
+  /**
+   * Will hash an object using the specified algorithm. The default algorithm is 'sha256'.
+   * @param {any} object the object to hash
+   * @param {string} algorithm the hash algorithm to use. The default is 'sha256'
+   * @returns {string} the hash of the object
+   */
+  hash(object, algorithm = HashAlgorithm.SHA256) {
+    const validAlgorithm = Object.values(HashAlgorithm).includes(algorithm) ? algorithm : HashAlgorithm.SHA256;
+    return hash(object, { algorithm: validAlgorithm });
+  }
+  async setManyKeyv(keyv, items) {
+    const entries = [];
+    for (const item of items) {
+      const finalTtl = shorthandToMilliseconds(item.ttl ?? this._ttl);
+      entries.push({ key: item.key, value: item.value, ttl: finalTtl });
+    }
+    await keyv.setMany(entries);
+    return true;
+  }
+  async hasManyKeyv(keyv, keys) {
+    const promises = [];
+    for (const key of keys) {
+      promises.push(keyv.has(key));
+    }
+    return Promise.all(promises);
+  }
+  /**
+   * Processes a single key from secondary store for getRaw operation
+   * @param primary - the primary store to use
+   * @param secondary - the secondary store to use
+   * @param key - The key to retrieve from secondary store
+   * @returns Promise containing the result and TTL information
+   */
+  async processSecondaryForGetRaw(primary, secondary, key) {
+    const secondaryResult = await secondary.getRaw(key);
+    if (secondaryResult?.value) {
+      this.emit("cache:hit" /* CACHE_HIT */, {
+        key,
+        value: secondaryResult.value,
+        store: "secondary"
+      });
+      const cascadeTtl = getCascadingTtl(this._ttl, this._primary.ttl);
+      const expires = secondaryResult.expires ?? void 0;
+      const ttl = calculateTtlFromExpiration(cascadeTtl, expires);
+      const setItem = { key, value: secondaryResult.value, ttl };
+      await this.hook("BEFORE_SECONDARY_SETS_PRIMARY" /* BEFORE_SECONDARY_SETS_PRIMARY */, setItem);
+      await primary.set(setItem.key, setItem.value, setItem.ttl);
+      return { result: secondaryResult, ttl };
+    } else {
+      this.emit("cache:miss" /* CACHE_MISS */, { key, store: "secondary" });
+      return void 0;
+    }
+  }
+  /**
+   * Processes a single key from secondary store for getRaw operation in non-blocking mode
+   * Non-blocking mode means we don't wait for secondary operations that update primary store
+   * @param primary - the primary store to use
+   * @param secondary - the secondary store to use
+   * @param key - The key to retrieve from secondary store
+   * @returns Promise containing the result and TTL information
+   */
+  async processSecondaryForGetRawNonBlocking(primary, secondary, key) {
+    const secondaryResult = await secondary.getRaw(key);
+    if (secondaryResult?.value) {
+      this.emit("cache:hit" /* CACHE_HIT */, {
+        key,
+        value: secondaryResult.value,
+        store: "secondary"
+      });
+      const cascadeTtl = getCascadingTtl(this._ttl, this._primary.ttl);
+      const expires = secondaryResult.expires ?? void 0;
+      const ttl = calculateTtlFromExpiration(cascadeTtl, expires);
+      const setItem = { key, value: secondaryResult.value, ttl };
+      this.hook("BEFORE_SECONDARY_SETS_PRIMARY" /* BEFORE_SECONDARY_SETS_PRIMARY */, setItem).then(async () => {
+        await primary.set(setItem.key, setItem.value, setItem.ttl);
+      }).catch((error) => {
+        this.emit("error" /* ERROR */, error);
+      });
+      return { result: secondaryResult, ttl };
+    } else {
+      this.emit("cache:miss" /* CACHE_MISS */, { key, store: "secondary" });
+      return void 0;
+    }
+  }
+  /**
+   * Processes missing keys from secondary store for getManyRaw operation
+   * @param primary - the primary store to use
+   * @param secondary - the secondary store to use
+   * @param keys - The original array of keys requested
+   * @param result - The result array from primary store (will be modified)
+   * @returns Promise<void>
+   */
+  async processSecondaryForGetManyRaw(primary, secondary, keys, result) {
+    const missingKeys = [];
+    for (const [i, key] of keys.entries()) {
+      if (!result[i]) {
+        missingKeys.push(key);
+      }
+    }
+    const secondaryResults = await secondary.getManyRaw(missingKeys);
+    let secondaryIndex = 0;
+    for await (const [i, key] of keys.entries()) {
+      if (!result[i]) {
+        const secondaryResult = secondaryResults[secondaryIndex];
+        if (secondaryResult && secondaryResult.value !== void 0) {
+          result[i] = secondaryResult;
+          this.emit("cache:hit" /* CACHE_HIT */, {
+            key,
+            value: secondaryResult.value,
+            store: "secondary"
+          });
+          const cascadeTtl = getCascadingTtl(this._ttl, this._primary.ttl);
+          let { expires } = secondaryResult;
+          if (expires === null) {
+            expires = void 0;
+          }
+          const ttl = calculateTtlFromExpiration(cascadeTtl, expires);
+          const setItem = { key, value: secondaryResult.value, ttl };
+          await this.hook(
+            "BEFORE_SECONDARY_SETS_PRIMARY" /* BEFORE_SECONDARY_SETS_PRIMARY */,
+            setItem
+          );
+          await primary.set(setItem.key, setItem.value, setItem.ttl);
+        } else {
+          this.emit("cache:miss" /* CACHE_MISS */, {
+            key,
+            store: "secondary"
+          });
+        }
+        secondaryIndex++;
+      }
+    }
+  }
+  /**
+   * Processes missing keys from secondary store for getManyRaw operation in non-blocking mode
+   * Non-blocking mode means we don't wait for secondary operations that update primary store
+   * @param secondary - the secondary store to use
+   * @param keys - The original array of keys requested
+   * @param result - The result array from primary store (will be modified)
+   * @returns Promise<void>
+   */
+  async processSecondaryForGetManyRawNonBlocking(primary, secondary, keys, result) {
+    const missingKeys = [];
+    for (const [i, key] of keys.entries()) {
+      if (!result[i]) {
+        missingKeys.push(key);
+      }
+    }
+    const secondaryResults = await secondary.getManyRaw(missingKeys);
+    let secondaryIndex = 0;
+    for await (const [i, key] of keys.entries()) {
+      if (!result[i]) {
+        const secondaryResult = secondaryResults[secondaryIndex];
+        if (secondaryResult && secondaryResult.value !== void 0) {
+          result[i] = secondaryResult;
+          this.emit("cache:hit" /* CACHE_HIT */, {
+            key,
+            value: secondaryResult.value,
+            store: "secondary"
+          });
+          const cascadeTtl = getCascadingTtl(this._ttl, this._primary.ttl);
+          let { expires } = secondaryResult;
+          if (expires === null) {
+            expires = void 0;
+          }
+          const ttl = calculateTtlFromExpiration(cascadeTtl, expires);
+          const setItem = { key, value: secondaryResult.value, ttl };
+          this.hook("BEFORE_SECONDARY_SETS_PRIMARY" /* BEFORE_SECONDARY_SETS_PRIMARY */, setItem).then(async () => {
+            await primary.set(setItem.key, setItem.value, setItem.ttl);
+          }).catch((error) => {
+            this.emit("error" /* ERROR */, error);
+          });
+        } else {
+          this.emit("cache:miss" /* CACHE_MISS */, {
+            key,
+            store: "secondary"
+          });
+        }
+        secondaryIndex++;
+      }
+    }
+  }
+  setTtl(ttl) {
+    if (typeof ttl === "string" || ttl === void 0) {
+      this._ttl = ttl;
+    } else if (ttl > 0) {
+      this._ttl = ttl;
+    } else {
+      this._ttl = void 0;
+    }
+  }
+};
+export {
+  Cacheable,
+  CacheableEvents,
+  CacheableHooks,
+  CacheableMemory,
+  Stats as CacheableStats,
+  HashAlgorithm2 as HashAlgorithm,
+  Keyv2 as Keyv,
+  KeyvCacheableMemory,
+  KeyvHooks,
+  calculateTtlFromExpiration2 as calculateTtlFromExpiration,
+  createKeyv2 as createKeyv,
+  getCascadingTtl2 as getCascadingTtl,
+  getOrSet2 as getOrSet,
+  hash2 as hash,
+  shorthandToMilliseconds2 as shorthandToMilliseconds,
+  shorthandToTime,
+  wrap2 as wrap,
+  wrapSync
+};