@cacheable/node-cache 1.2.0 → 1.3.0

package/README.md

@@ -79,13 +79,21 @@ When initializing the cache you can pass in the options below:
 
 ```javascript
 export type NodeCacheStoreOptions = {
-	ttl?: number; // The standard ttl as number in seconds for every generated cache element. 0 = unlimited
+	ttl?: number; // The standard ttl as number in milliseconds for every generated cache element. 0 = unlimited
 	primary?: Keyv; // The primary storage adapter
 	secondary?: Keyv; // The secondary storage adapter
 	maxKeys?: number; // Default is 0 (unlimited). If this is set it will throw and error if you try to set more keys than the max.
 };
 ```
 
+Note: the `ttl` is now in milliseconds and not seconds like `stdTTL` in `NodeCache`. You can learn more about using shorthand also in the [cacheable documentation](https://github.com/jaredwray/cacheable/blob/main/packages/cacheable/README.md#shorthand-for-time-to-live-ttl). as it is fulling supported. Here is an example:
+
+```javascript
+const cache = new NodeCacheStore({ttl: 60000 }); // 1 minute as it defaults to milliseconds
+cache.set('foo', 'bar', '1h'); // 1 hour
+cache.set('longfoo', 'bar', '1d'); // 1 day
+```
+
 ### Node Cache Store API
 
 * `set(key: string | number, value: any, ttl?: number): Promise<boolean>` - Set a key value pair with an optional ttl (in milliseconds). Will return true on success. If the ttl is not set it will default to 0 (no ttl)
@@ -99,7 +107,7 @@ export type NodeCacheStoreOptions = {
 * `setTtl(key: string | number, ttl: number): Promise<boolean>` - Set the ttl of a key
 * `disconnect(): Promise<void>` - Disconnect the storage adapters
 * `stats`: `NodeCacheStats` - Get the stats of the cache
-* `ttl`: `number` - The standard ttl as number in seconds for every generated cache element. 0 = unlimited
+* `ttl`: `number` | `string` - The standard ttl as number in seconds for every generated cache element. `< 0` or `undefined` = unlimited
 * `primary`: `Keyv` - The primary storage adapter
 * `secondary`: `Keyv` - The secondary storage adapter
 * `maxKeys`: `number` - If this is set it will throw and error if you try to set more keys than the max

package/dist/index.cjs

@@ -96,8 +96,7 @@ var NodeCacheStore = class {
         return false;
       }
     }
-    const finalTtl = ttl ?? this._cache.ttl;
-    await this._cache.set(key.toString(), value, finalTtl);
+    await this._cache.set(key.toString(), value, ttl);
     return true;
   }
   async mset(list) {
@@ -127,10 +126,9 @@ var NodeCacheStore = class {
     return this._cache.clear();
   }
   async setTtl(key, ttl) {
-    const finalTtl = ttl ?? this._cache.ttl;
     const item = await this._cache.get(key.toString());
     if (item) {
-      await this._cache.set(key.toString(), item, finalTtl);
+      await this._cache.set(key.toString(), item, ttl);
       return true;
     }
     return false;

package/dist/index.d.cts

@@ -3,7 +3,7 @@ import { Cacheable } from 'cacheable';
 import { Keyv } from 'keyv';
 
 type NodeCacheStoreOptions = {
-    ttl?: number;
+    ttl?: number | string;
     maxKeys?: number;
     primary?: Keyv;
     secondary?: Keyv;
@@ -13,8 +13,8 @@ declare class NodeCacheStore {
     private readonly _cache;
     constructor(options?: NodeCacheStoreOptions);
     get cache(): Cacheable;
-    get ttl(): number | undefined;
-    set ttl(ttl: number | undefined);
+    get ttl(): number | string | undefined;
+    set ttl(ttl: number | string | undefined);
     get primary(): Keyv;
     set primary(primary: Keyv);
     get secondary(): Keyv | undefined;

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { Cacheable } from 'cacheable';
 import { Keyv } from 'keyv';
 
 type NodeCacheStoreOptions = {
-    ttl?: number;
+    ttl?: number | string;
     maxKeys?: number;
     primary?: Keyv;
     secondary?: Keyv;
@@ -13,8 +13,8 @@ declare class NodeCacheStore {
     private readonly _cache;
     constructor(options?: NodeCacheStoreOptions);
     get cache(): Cacheable;
-    get ttl(): number | undefined;
-    set ttl(ttl: number | undefined);
+    get ttl(): number | string | undefined;
+    set ttl(ttl: number | string | undefined);
     get primary(): Keyv;
     set primary(primary: Keyv);
     get secondary(): Keyv | undefined;

package/dist/index.js

@@ -60,8 +60,7 @@ var NodeCacheStore = class {
         return false;
       }
     }
-    const finalTtl = ttl ?? this._cache.ttl;
-    await this._cache.set(key.toString(), value, finalTtl);
+    await this._cache.set(key.toString(), value, ttl);
     return true;
   }
   async mset(list) {
@@ -91,10 +90,9 @@ var NodeCacheStore = class {
     return this._cache.clear();
   }
   async setTtl(key, ttl) {
-    const finalTtl = ttl ?? this._cache.ttl;
     const item = await this._cache.get(key.toString());
     if (item) {
-      await this._cache.set(key.toString(), item, finalTtl);
+      await this._cache.set(key.toString(), item, ttl);
       return true;
     }
     return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cacheable/node-cache",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Simple and Maintained fast NodeJS internal caching",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -27,7 +27,7 @@
     "cacheable-node"
   ],
   "devDependencies": {
-    "@types/node": "^22.6.0",
+    "@types/node": "^22.7.4",
     "@vitest/coverage-v8": "^2.1.1",
     "rimraf": "^6.0.1",
     "tsup": "^8.3.0",
@@ -36,7 +36,7 @@
     "xo": "^0.59.3"
   },
   "dependencies": {
-    "cacheable": "^1.3.0",
+    "cacheable": "^1.7.0",
     "eventemitter3": "^5.0.1",
     "keyv": "^5.0.3"
   },