@sebspark/promise-cache 3.10.1 → 4.0.0

package/dist/index.d.mts

@@ -105,9 +105,7 @@ declare class PromiseCache<U> {
     wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKeyInSeconds?: string): Promise<U>;
 }
 
-type Client = ReturnType<typeof createClient>;
-type Multi = ReturnType<Client['multi']>;
-type MultiExecReturnTypes = Awaited<ReturnType<Multi['exec']>>[number] | boolean;
+type MultiExecReturnTypes = string[] | string | number | boolean | null | undefined;
 /**
  * Defines the expiration strategy for cached values.
  *
@@ -186,7 +184,7 @@ interface IPersistor {
      * @param seconds - TTL in seconds.
      * @returns Resolves to `true` if the expiration was successfully set, `false` if the key does not exist.
      */
-    expire: (key: string, seconds: number) => Promise<boolean>;
+    expire: (key: string, seconds: number) => Promise<number>;
     /**
      * Gets the remaining TTL (time-to-live) of a key.
      * @param key - The storage key.
@@ -223,7 +221,7 @@ interface IPersistor {
      * @param value - The string value to store.
      * @returns Resolves to `true` if the key was set, or `false` if the key already exists.
      */
-    setNX: (key: string, value: string) => Promise<boolean>;
+    setNX: (key: string, value: string) => Promise<number>;
     /**
      * Creates a multi-command batch operation.
      * This allows multiple commands to be executed in a batch, improving performance.
@@ -276,7 +274,7 @@ interface IPersistor {
      * @param field - The field name.
      * @returns Resolves to the value, or `undefined` if the field does not exist.
      */
-    hGet: (key: string, field: string) => Promise<string | undefined>;
+    hGet: (key: string, field: string) => Promise<string | null>;
     /**
      * Pushes values to the left (head) of a list.
      * @param key - The list key.
@@ -560,7 +558,7 @@ interface IPersistorMulti {
      * @returns A promise resolving to an array of results for each command.
      * The result type can be `string | number | boolean | null`, depending on the command.
      */
-    exec: () => Promise<MultiExecReturnTypes[]>;
+    exec: () => Promise<MultiExecReturnTypes[] | unknown>;
 }
 
 /**
@@ -641,7 +639,7 @@ declare class InMemoryPersistor implements IPersistor {
      * @param value - The string value to store.
      * @returns Resolves to `true` if the key was set, or `false` if the key already exists.
      */
-    setNX(key: string, value: string): Promise<boolean>;
+    setNX(key: string, value: string): Promise<number>;
     /**
      * Retrieves the value associated with a key.
      *
@@ -665,7 +663,7 @@ declare class InMemoryPersistor implements IPersistor {
      * @param {number} seconds - The TTL in seconds.
      * @returns {Promise<number>} Resolves to `1` if the TTL was set, or `0` if the key does not exist.
      */
-    expire(key: string, seconds: number): Promise<boolean>;
+    expire(key: string, seconds: number): Promise<number>;
     /**
      * Retrieves the remaining time-to-live (TTL) of a key in seconds.
      *
@@ -732,9 +730,9 @@ declare class InMemoryPersistor implements IPersistor {
      *
      * @param key - The hash key.
      * @param field - The field name to retrieve.
-     * @returns Resolves to the field value, or `undefined` if the field does not exist.
+     * @returns Resolves to the field value, or `null` if the field does not exist.
      */
-    hGet(key: string, field: string): Promise<string | undefined>;
+    hGet(key: string, field: string): Promise<string | null>;
     /**
      * Pushes elements to the left (head) of a list.
      *

package/dist/index.d.ts

@@ -105,9 +105,7 @@ declare class PromiseCache<U> {
     wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number, ttlKeyInSeconds?: string): Promise<U>;
 }
 
-type Client = ReturnType<typeof createClient>;
-type Multi = ReturnType<Client['multi']>;
-type MultiExecReturnTypes = Awaited<ReturnType<Multi['exec']>>[number] | boolean;
+type MultiExecReturnTypes = string[] | string | number | boolean | null | undefined;
 /**
  * Defines the expiration strategy for cached values.
  *
@@ -186,7 +184,7 @@ interface IPersistor {
      * @param seconds - TTL in seconds.
      * @returns Resolves to `true` if the expiration was successfully set, `false` if the key does not exist.
      */
-    expire: (key: string, seconds: number) => Promise<boolean>;
+    expire: (key: string, seconds: number) => Promise<number>;
     /**
      * Gets the remaining TTL (time-to-live) of a key.
      * @param key - The storage key.
@@ -223,7 +221,7 @@ interface IPersistor {
      * @param value - The string value to store.
      * @returns Resolves to `true` if the key was set, or `false` if the key already exists.
      */
-    setNX: (key: string, value: string) => Promise<boolean>;
+    setNX: (key: string, value: string) => Promise<number>;
     /**
      * Creates a multi-command batch operation.
      * This allows multiple commands to be executed in a batch, improving performance.
@@ -276,7 +274,7 @@ interface IPersistor {
      * @param field - The field name.
      * @returns Resolves to the value, or `undefined` if the field does not exist.
      */
-    hGet: (key: string, field: string) => Promise<string | undefined>;
+    hGet: (key: string, field: string) => Promise<string | null>;
     /**
      * Pushes values to the left (head) of a list.
      * @param key - The list key.
@@ -560,7 +558,7 @@ interface IPersistorMulti {
      * @returns A promise resolving to an array of results for each command.
      * The result type can be `string | number | boolean | null`, depending on the command.
      */
-    exec: () => Promise<MultiExecReturnTypes[]>;
+    exec: () => Promise<MultiExecReturnTypes[] | unknown>;
 }
 
 /**
@@ -641,7 +639,7 @@ declare class InMemoryPersistor implements IPersistor {
      * @param value - The string value to store.
      * @returns Resolves to `true` if the key was set, or `false` if the key already exists.
      */
-    setNX(key: string, value: string): Promise<boolean>;
+    setNX(key: string, value: string): Promise<number>;
     /**
      * Retrieves the value associated with a key.
      *
@@ -665,7 +663,7 @@ declare class InMemoryPersistor implements IPersistor {
      * @param {number} seconds - The TTL in seconds.
      * @returns {Promise<number>} Resolves to `1` if the TTL was set, or `0` if the key does not exist.
      */
-    expire(key: string, seconds: number): Promise<boolean>;
+    expire(key: string, seconds: number): Promise<number>;
     /**
      * Retrieves the remaining time-to-live (TTL) of a key in seconds.
      *
@@ -732,9 +730,9 @@ declare class InMemoryPersistor implements IPersistor {
      *
      * @param key - The hash key.
      * @param field - The field name to retrieve.
-     * @returns Resolves to the field value, or `undefined` if the field does not exist.
+     * @returns Resolves to the field value, or `null` if the field does not exist.
      */
-    hGet(key: string, field: string): Promise<string | undefined>;
+    hGet(key: string, field: string): Promise<string | null>;
     /**
      * Pushes elements to the left (head) of a list.
      *

package/dist/index.js

@@ -582,9 +582,9 @@ var InMemoryPersistor = class {
    * @returns Resolves to `true` if the key was set, or `false` if the key already exists.
    */
   async setNX(key, value) {
-    if (this.store.has(key)) return false;
+    if (this.store.has(key)) return 0;
     this.store.set(key, value);
-    return true;
+    return 1;
   }
   /**
    * Retrieves the value associated with a key.
@@ -619,9 +619,9 @@ var InMemoryPersistor = class {
    * @returns {Promise<number>} Resolves to `1` if the TTL was set, or `0` if the key does not exist.
    */
   async expire(key, seconds2) {
-    if (!this.store.has(key)) return false;
+    if (!this.store.has(key)) return 0;
     this.setExpiration(key, seconds2 * 1e3);
-    return true;
+    return 1;
   }
   /**
    * Retrieves the remaining time-to-live (TTL) of a key in seconds.
@@ -729,11 +729,11 @@ var InMemoryPersistor = class {
    *
    * @param key - The hash key.
    * @param field - The field name to retrieve.
-   * @returns Resolves to the field value, or `undefined` if the field does not exist.
+   * @returns Resolves to the field value, or `null` if the field does not exist.
    */
   async hGet(key, field) {
     const hash = JSON.parse(this.store.get(key) ?? "{}");
-    return hash[field] ?? void 0;
+    return hash[field] ?? null;
   }
   /**
    * Pushes elements to the left (head) of a list.

package/dist/index.mjs

@@ -563,9 +563,9 @@ var InMemoryPersistor = class {
    * @returns Resolves to `true` if the key was set, or `false` if the key already exists.
    */
   async setNX(key, value) {
-    if (this.store.has(key)) return false;
+    if (this.store.has(key)) return 0;
     this.store.set(key, value);
-    return true;
+    return 1;
   }
   /**
    * Retrieves the value associated with a key.
@@ -600,9 +600,9 @@ var InMemoryPersistor = class {
    * @returns {Promise<number>} Resolves to `1` if the TTL was set, or `0` if the key does not exist.
    */
   async expire(key, seconds2) {
-    if (!this.store.has(key)) return false;
+    if (!this.store.has(key)) return 0;
     this.setExpiration(key, seconds2 * 1e3);
-    return true;
+    return 1;
   }
   /**
    * Retrieves the remaining time-to-live (TTL) of a key in seconds.
@@ -710,11 +710,11 @@ var InMemoryPersistor = class {
    *
    * @param key - The hash key.
    * @param field - The field name to retrieve.
-   * @returns Resolves to the field value, or `undefined` if the field does not exist.
+   * @returns Resolves to the field value, or `null` if the field does not exist.
    */
   async hGet(key, field) {
     const hash = JSON.parse(this.store.get(key) ?? "{}");
-    return hash[field] ?? void 0;
+    return hash[field] ?? null;
   }
   /**
    * Pushes elements to the left (head) of a list.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/promise-cache",
-  "version": "3.10.1",
+  "version": "4.0.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -24,7 +24,7 @@
   "dependencies": {
     "date-fn": "^0.0.2",
     "fix-esm": "1.0.1",
-    "redis": "4.7.1",
+    "redis": "5.5.6",
     "superjson": "2.2.2"
   }
 }