@cacheable/node-cache 1.4.1 → 1.5.0

package/README.md

@@ -42,6 +42,12 @@ import {NodeCache} from '@cacheable/node-cache';
 const cache = new NodeCache();
 cache.set('foo', 'bar');
 cache.get('foo'); // 'bar'
+
+cache.set('foo', 'bar', 10); // 10 seconds
+
+cache.del('foo'); // true
+
+cache.set('bar', 'baz', '35m'); // 35 minutes using shorthand
 ```
 
 # Advanced Usage
@@ -121,7 +127,7 @@ Create a new cache instance. You can pass in options to set the configuration:
 
 ```javascript
 export type NodeCacheOptions = {
-	stdTTL?: number; // The standard ttl as number in seconds for every generated cache element. 0 = unlimited
+	stdTTL?: number; // The standard ttl as number in seconds for every generated cache element. 0 = unlimited. If string, it will be parsed as shorthand and default to milliseconds if it is a number as a string.
 	checkperiod?: number; // Default is 600, 0 means no periodic check
 	useClones?: boolean; // Default is true
 	deleteOnExpire?: boolean; // Default is true, if this is set to true it will delete the key when it expires.

package/dist/index.cjs

@@ -240,7 +240,7 @@ var NodeCacheErrors = /* @__PURE__ */ ((NodeCacheErrors2) => {
   NodeCacheErrors2["ECACHEFULL"] = "Cache max keys amount exceeded";
   NodeCacheErrors2["EKEYTYPE"] = "The key argument has to be of type `string` or `number`. Found: `__key`";
   NodeCacheErrors2["EKEYSTYPE"] = "The keys argument has to be an array.";
-  NodeCacheErrors2["ETTLTYPE"] = "The ttl argument has to be a number.";
+  NodeCacheErrors2["ETTLTYPE"] = "The ttl argument has to be a number or a string for shorthand ttl.";
   return NodeCacheErrors2;
 })(NodeCacheErrors || {});
 var NodeCache = class extends import_eventemitter3.default {
@@ -267,21 +267,27 @@ var NodeCache = class extends import_eventemitter3.default {
    * Sets a key value pair. It is possible to define a ttl (in seconds). Returns true on success.
    * @param {string | number} key - it will convert the key to a string
    * @param {any} value
-   * @param {number} [ttl] - this is in seconds and undefined will use the default ttl
+   * @param {number | string} [ttl] - this is in seconds and undefined will use the default ttl
    * @returns {boolean}
    */
   set(key, value, ttl) {
     if (typeof key !== "string" && typeof key !== "number") {
       throw this.createError("The key argument has to be of type `string` or `number`. Found: `__key`" /* EKEYTYPE */, key);
     }
-    if (ttl && typeof ttl !== "number") {
-      throw this.createError("The ttl argument has to be a number." /* ETTLTYPE */, this.formatKey(key));
+    if (ttl && typeof ttl !== "number" && typeof ttl !== "string") {
+      throw this.createError("The ttl argument has to be a number or a string for shorthand ttl." /* ETTLTYPE */, this.formatKey(key));
     }
     const keyValue = this.formatKey(key);
-    const ttlValue = ttl ?? this.options.stdTTL;
+    let ttlValue = 0;
+    if (this.options.stdTTL) {
+      ttlValue = this.getExpirationTimestamp(this.options.stdTTL);
+    }
+    if (ttl) {
+      ttlValue = this.getExpirationTimestamp(ttl);
+    }
     let expirationTimestamp = 0;
     if (ttlValue && ttlValue > 0) {
-      expirationTimestamp = this.getExpirationTimestamp(ttlValue);
+      expirationTimestamp = ttlValue;
     }
     if (this.options.maxKeys) {
       const maxKeys = this.options.maxKeys;
@@ -412,7 +418,7 @@ var NodeCache = class extends import_eventemitter3.default {
    * Redefine the ttl of a key. Returns true if the key has been found and changed.
    * Otherwise returns false. If the ttl-argument isn't passed the default-TTL will be used.
    * @param {string | number} key if the key is a number it will convert it to a string
-   * @param {number} [ttl] the ttl in seconds
+   * @param {number | string} [ttl] the ttl in seconds if number, or a shorthand string like '1h' for 1 hour
    * @returns {boolean} true if the key has been found and changed. Otherwise returns false.
    */
   ttl(key, ttl) {
@@ -509,6 +515,9 @@ var NodeCache = class extends import_eventemitter3.default {
     return key.toString();
   }
   getExpirationTimestamp(ttlInSeconds) {
+    if (typeof ttlInSeconds === "string") {
+      return (0, import_cacheable2.shorthandToTime)(ttlInSeconds);
+    }
     const currentTimestamp = Date.now();
     const ttlInMilliseconds = ttlInSeconds * 1e3;
     const expirationTimestamp = currentTimestamp + ttlInMilliseconds;

package/dist/index.d.cts

@@ -142,9 +142,9 @@ declare class NodeCacheStore {
 
 type NodeCacheOptions = {
     /**
-     * The standard ttl as number in seconds for every generated cache element. 0 = unlimited
+     * The standard ttl as number in seconds for every generated cache element. 0 = unlimited, If string, it will be in shorthand format like '1h' for 1 hour
      */
-    stdTTL?: number;
+    stdTTL?: number | string;
     /**
      * The interval to check for expired items in seconds. Default is 600 = 5 minutes
      */
@@ -181,7 +181,7 @@ declare enum NodeCacheErrors {
     ECACHEFULL = "Cache max keys amount exceeded",
     EKEYTYPE = "The key argument has to be of type `string` or `number`. Found: `__key`",
     EKEYSTYPE = "The keys argument has to be an array.",
-    ETTLTYPE = "The ttl argument has to be a number."
+    ETTLTYPE = "The ttl argument has to be a number or a string for shorthand ttl."
 }
 type NodeCacheStats = {
     /**
@@ -216,10 +216,10 @@ declare class NodeCache extends eventemitter {
      * Sets a key value pair. It is possible to define a ttl (in seconds). Returns true on success.
      * @param {string | number} key - it will convert the key to a string
      * @param {any} value
-     * @param {number} [ttl] - this is in seconds and undefined will use the default ttl
+     * @param {number | string} [ttl] - this is in seconds and undefined will use the default ttl
      * @returns {boolean}
      */
-    set(key: string | number, value: any, ttl?: number): boolean;
+    set(key: string | number, value: any, ttl?: number | string): boolean;
     /**
      * Sets multiple key val pairs. It is possible to define a ttl (seconds). Returns true on success.
      * @param {NodeCacheItem[]} data an array of key value pairs with optional ttl
@@ -262,10 +262,10 @@ declare class NodeCache extends eventemitter {
      * Redefine the ttl of a key. Returns true if the key has been found and changed.
      * Otherwise returns false. If the ttl-argument isn't passed the default-TTL will be used.
      * @param {string | number} key if the key is a number it will convert it to a string
-     * @param {number} [ttl] the ttl in seconds
+     * @param {number | string} [ttl] the ttl in seconds if number, or a shorthand string like '1h' for 1 hour
      * @returns {boolean} true if the key has been found and changed. Otherwise returns false.
      */
-    ttl(key: string | number, ttl?: number): boolean;
+    ttl(key: string | number, ttl?: number | string): boolean;
     /**
      * Receive the ttl of a key.
      * @param {string | number} key if the key is a number it will convert it to a string

package/dist/index.d.ts

@@ -142,9 +142,9 @@ declare class NodeCacheStore {
 
 type NodeCacheOptions = {
     /**
-     * The standard ttl as number in seconds for every generated cache element. 0 = unlimited
+     * The standard ttl as number in seconds for every generated cache element. 0 = unlimited, If string, it will be in shorthand format like '1h' for 1 hour
      */
-    stdTTL?: number;
+    stdTTL?: number | string;
     /**
      * The interval to check for expired items in seconds. Default is 600 = 5 minutes
      */
@@ -181,7 +181,7 @@ declare enum NodeCacheErrors {
     ECACHEFULL = "Cache max keys amount exceeded",
     EKEYTYPE = "The key argument has to be of type `string` or `number`. Found: `__key`",
     EKEYSTYPE = "The keys argument has to be an array.",
-    ETTLTYPE = "The ttl argument has to be a number."
+    ETTLTYPE = "The ttl argument has to be a number or a string for shorthand ttl."
 }
 type NodeCacheStats = {
     /**
@@ -216,10 +216,10 @@ declare class NodeCache extends eventemitter {
      * Sets a key value pair. It is possible to define a ttl (in seconds). Returns true on success.
      * @param {string | number} key - it will convert the key to a string
      * @param {any} value
-     * @param {number} [ttl] - this is in seconds and undefined will use the default ttl
+     * @param {number | string} [ttl] - this is in seconds and undefined will use the default ttl
      * @returns {boolean}
      */
-    set(key: string | number, value: any, ttl?: number): boolean;
+    set(key: string | number, value: any, ttl?: number | string): boolean;
     /**
      * Sets multiple key val pairs. It is possible to define a ttl (seconds). Returns true on success.
      * @param {NodeCacheItem[]} data an array of key value pairs with optional ttl
@@ -262,10 +262,10 @@ declare class NodeCache extends eventemitter {
      * Redefine the ttl of a key. Returns true if the key has been found and changed.
      * Otherwise returns false. If the ttl-argument isn't passed the default-TTL will be used.
      * @param {string | number} key if the key is a number it will convert it to a string
-     * @param {number} [ttl] the ttl in seconds
+     * @param {number | string} [ttl] the ttl in seconds if number, or a shorthand string like '1h' for 1 hour
      * @returns {boolean} true if the key has been found and changed. Otherwise returns false.
      */
-    ttl(key: string | number, ttl?: number): boolean;
+    ttl(key: string | number, ttl?: number | string): boolean;
     /**
      * Receive the ttl of a key.
      * @param {string | number} key if the key is a number it will convert it to a string

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/index.ts
 import eventemitter from "eventemitter3";
-import { CacheableMemory as CacheableMemory2, CacheableStats } from "cacheable";
+import { CacheableMemory as CacheableMemory2, CacheableStats, shorthandToTime } from "cacheable";
 
 // src/store.ts
 import { Cacheable, CacheableMemory } from "cacheable";
@@ -204,7 +204,7 @@ var NodeCacheErrors = /* @__PURE__ */ ((NodeCacheErrors2) => {
   NodeCacheErrors2["ECACHEFULL"] = "Cache max keys amount exceeded";
   NodeCacheErrors2["EKEYTYPE"] = "The key argument has to be of type `string` or `number`. Found: `__key`";
   NodeCacheErrors2["EKEYSTYPE"] = "The keys argument has to be an array.";
-  NodeCacheErrors2["ETTLTYPE"] = "The ttl argument has to be a number.";
+  NodeCacheErrors2["ETTLTYPE"] = "The ttl argument has to be a number or a string for shorthand ttl.";
   return NodeCacheErrors2;
 })(NodeCacheErrors || {});
 var NodeCache = class extends eventemitter {
@@ -231,21 +231,27 @@ var NodeCache = class extends eventemitter {
    * Sets a key value pair. It is possible to define a ttl (in seconds). Returns true on success.
    * @param {string | number} key - it will convert the key to a string
    * @param {any} value
-   * @param {number} [ttl] - this is in seconds and undefined will use the default ttl
+   * @param {number | string} [ttl] - this is in seconds and undefined will use the default ttl
    * @returns {boolean}
    */
   set(key, value, ttl) {
     if (typeof key !== "string" && typeof key !== "number") {
       throw this.createError("The key argument has to be of type `string` or `number`. Found: `__key`" /* EKEYTYPE */, key);
     }
-    if (ttl && typeof ttl !== "number") {
-      throw this.createError("The ttl argument has to be a number." /* ETTLTYPE */, this.formatKey(key));
+    if (ttl && typeof ttl !== "number" && typeof ttl !== "string") {
+      throw this.createError("The ttl argument has to be a number or a string for shorthand ttl." /* ETTLTYPE */, this.formatKey(key));
     }
     const keyValue = this.formatKey(key);
-    const ttlValue = ttl ?? this.options.stdTTL;
+    let ttlValue = 0;
+    if (this.options.stdTTL) {
+      ttlValue = this.getExpirationTimestamp(this.options.stdTTL);
+    }
+    if (ttl) {
+      ttlValue = this.getExpirationTimestamp(ttl);
+    }
     let expirationTimestamp = 0;
     if (ttlValue && ttlValue > 0) {
-      expirationTimestamp = this.getExpirationTimestamp(ttlValue);
+      expirationTimestamp = ttlValue;
     }
     if (this.options.maxKeys) {
       const maxKeys = this.options.maxKeys;
@@ -376,7 +382,7 @@ var NodeCache = class extends eventemitter {
    * Redefine the ttl of a key. Returns true if the key has been found and changed.
    * Otherwise returns false. If the ttl-argument isn't passed the default-TTL will be used.
    * @param {string | number} key if the key is a number it will convert it to a string
-   * @param {number} [ttl] the ttl in seconds
+   * @param {number | string} [ttl] the ttl in seconds if number, or a shorthand string like '1h' for 1 hour
    * @returns {boolean} true if the key has been found and changed. Otherwise returns false.
    */
   ttl(key, ttl) {
@@ -473,6 +479,9 @@ var NodeCache = class extends eventemitter {
     return key.toString();
   }
   getExpirationTimestamp(ttlInSeconds) {
+    if (typeof ttlInSeconds === "string") {
+      return shorthandToTime(ttlInSeconds);
+    }
     const currentTimestamp = Date.now();
     const ttlInMilliseconds = ttlInSeconds * 1e3;
     const expirationTimestamp = currentTimestamp + ttlInMilliseconds;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cacheable/node-cache",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Simple and Maintained fast NodeJS internal caching",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -42,7 +42,7 @@
   "dependencies": {
     "cacheable": "^1.8.1",
     "eventemitter3": "^5.0.1",
-    "keyv": "^5.1.2"
+    "keyv": "^5.2.1"
   },
   "files": [
     "dist",