@sebspark/promise-cache 2.0.10 → 2.1.0

package/dist/index.d.mts

@@ -75,9 +75,10 @@ declare class PromiseCache<U> {
      * @param key Cache key.
      * @param delegate The function to execute if the key is not in the cache.
      * @param ttlInSeconds Time to live in seconds.
+     * @param ttlKey The key in the response object that contains the TTL.
      * @returns The result of the delegate function.
      */
-    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number): Promise<U>;
+    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKey?: string): Promise<U>;
 }
 
 declare class LocalStorage {

package/dist/index.d.ts

@@ -75,9 +75,10 @@ declare class PromiseCache<U> {
      * @param key Cache key.
      * @param delegate The function to execute if the key is not in the cache.
      * @param ttlInSeconds Time to live in seconds.
+     * @param ttlKey The key in the response object that contains the TTL.
      * @returns The result of the delegate function.
      */
-    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number): Promise<U>;
+    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKey?: string): Promise<U>;
 }
 
 declare class LocalStorage {

package/dist/index.js

@@ -283,15 +283,16 @@ var PromiseCache = class {
    * @param key Cache key.
    * @param delegate The function to execute if the key is not in the cache.
    * @param ttlInSeconds Time to live in seconds.
+   * @param ttlKey The key in the response object that contains the TTL.
    * @returns The result of the delegate function.
    */
-  async wrap(key, delegate, ttlInSeconds) {
+  async wrap(key, delegate, ttlInSeconds, ttlKey) {
     const now = Date.now();
     const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
-    const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
+    let effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
     const cached = await this.persistor.get(effectiveKey);
     if (cached) {
-      if (cached.ttl !== effectiveTTL) {
+      if (!ttlKey && cached.ttl !== effectiveTTL) {
         console.error(
           `WARNING: TTL mismatch for key: ${effectiveKey}. It is recommended to use the same TTL for the same key.`
         );
@@ -299,6 +300,10 @@ var PromiseCache = class {
       return cached.value;
     }
     const response = await delegate();
+    if (ttlKey) {
+      const responseDict = response;
+      effectiveTTL = Number(responseDict[ttlKey]) || effectiveTTL;
+    }
     this.persistor.set(effectiveKey, {
       value: response,
       timestamp: now,

package/dist/index.mjs

@@ -254,15 +254,16 @@ var PromiseCache = class {
    * @param key Cache key.
    * @param delegate The function to execute if the key is not in the cache.
    * @param ttlInSeconds Time to live in seconds.
+   * @param ttlKey The key in the response object that contains the TTL.
    * @returns The result of the delegate function.
    */
-  async wrap(key, delegate, ttlInSeconds) {
+  async wrap(key, delegate, ttlInSeconds, ttlKey) {
     const now = Date.now();
     const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
-    const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
+    let effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
     const cached = await this.persistor.get(effectiveKey);
     if (cached) {
-      if (cached.ttl !== effectiveTTL) {
+      if (!ttlKey && cached.ttl !== effectiveTTL) {
         console.error(
           `WARNING: TTL mismatch for key: ${effectiveKey}. It is recommended to use the same TTL for the same key.`
         );
@@ -270,6 +271,10 @@ var PromiseCache = class {
       return cached.value;
     }
     const response = await delegate();
+    if (ttlKey) {
+      const responseDict = response;
+      effectiveTTL = Number(responseDict[ttlKey]) || effectiveTTL;
+    }
     this.persistor.set(effectiveKey, {
       value: response,
       timestamp: now,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/promise-cache",
-  "version": "2.0.10",
+  "version": "2.1.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",