@cacheable/node-cache 1.2.1 → 1.4.0

package/README.md

@@ -1,4 +1,4 @@
-[<img align="center" src="https://cacheable.org/logo.svg" alt="Cacheable" />](https://github.com/jaredwray/cacheable)
+[<img align="center" src="https://cacheable.org/symbol.svg" alt="Cacheable" />](https://github.com/jaredwray/cacheable)
 
 # Node-Cache
 
@@ -86,7 +86,13 @@ export type NodeCacheStoreOptions = {
 };
 ```
 
-Note: the `ttl` is now in milliseconds and not seconds like `stdTTL` in `NodeCache`.
+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
 
@@ -101,7 +107,7 @@ Note: the `ttl` is now in milliseconds and not seconds like `stdTTL` in `NodeCac
 * `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;
@@ -42,7 +42,7 @@ type NodeCacheOptions = {
 };
 type NodeCacheItem = {
     key: string | number;
-    value: any;
+    value: unknown;
     ttl?: number;
 };
 declare enum NodeCacheErrors {
@@ -67,8 +67,8 @@ declare class NodeCache extends eventemitter {
     constructor(options?: NodeCacheOptions);
     set(key: string | number, value: any, ttl?: number): boolean;
     mset(data: NodeCacheItem[]): boolean;
-    get(key: string | number): any;
-    mget(keys: Array<string | number>): Record<string, unknown>;
+    get<T>(key: string | number): any;
+    mget<T>(keys: Array<string | number>): Record<string, unknown>;
     take(key: string | number): any;
     del(key: string | number | Array<string | number>): number;
     mdel(keys: Array<string | number>): number;

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;
@@ -42,7 +42,7 @@ type NodeCacheOptions = {
 };
 type NodeCacheItem = {
     key: string | number;
-    value: any;
+    value: unknown;
     ttl?: number;
 };
 declare enum NodeCacheErrors {
@@ -67,8 +67,8 @@ declare class NodeCache extends eventemitter {
     constructor(options?: NodeCacheOptions);
     set(key: string | number, value: any, ttl?: number): boolean;
     mset(data: NodeCacheItem[]): boolean;
-    get(key: string | number): any;
-    mget(keys: Array<string | number>): Record<string, unknown>;
+    get<T>(key: string | number): any;
+    mget<T>(keys: Array<string | number>): Record<string, unknown>;
     take(key: string | number): any;
     del(key: string | number | Array<string | number>): number;
     mdel(keys: Array<string | number>): number;

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.1",
+  "version": "1.4.0",
   "description": "Simple and Maintained fast NodeJS internal caching",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -36,7 +36,7 @@
     "xo": "^0.59.3"
   },
   "dependencies": {
-    "cacheable": "^1.6.0",
+    "cacheable": "^1.7.0",
     "eventemitter3": "^5.0.1",
     "keyv": "^5.0.3"
   },