@cacheable/node-cache 1.0.0 → 1.1.0

package/README.md

@@ -90,11 +90,14 @@ export type NodeCacheStoreOptions = {
 
 * `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)
 * `mset(data: Array<NodeCacheItem>): Promise<boolean>` - Set multiple key value pairs at once
-* `get(key: string | number): Promise<any>` - Get a value from the cache by key
+* `get<T>(key: string | number): Promise<T>` - Get a value from the cache by key
 * `mget(keys: Array<string | number>): Promise<Record<string, unknown>>` - Get multiple values from the cache by keys
+* `take<T>(key: string | number): Promise<T>` - Get a value from the cache by key and delete it
 * `del(key: string | number): Promise<boolean>` - Delete a key
 * `mdel(keys: Array<string | number>): Promise<boolean>` - Delete multiple keys
 * `clear(): Promise<void>` - Clear the cache
+* `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
 * `primary`: `Keyv` - The primary storage adapter

package/dist/index.cjs

@@ -127,6 +127,21 @@ var NodeCacheStore = class {
   async clear() {
     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);
+      return true;
+    }
+    return false;
+  }
+  async take(key) {
+    return this._cache.take(key.toString());
+  }
+  async disconnect() {
+    await this._cache.disconnect();
+  }
 };
 
 // src/index.ts

package/dist/index.d.cts

@@ -28,6 +28,9 @@ declare class NodeCacheStore {
     del(key: string | number): Promise<boolean>;
     mdel(keys: Array<string | number>): Promise<boolean>;
     clear(): Promise<void>;
+    setTtl(key: string | number, ttl?: number): Promise<boolean>;
+    take<T>(key: string | number): Promise<T | undefined>;
+    disconnect(): Promise<void>;
 }
 
 type NodeCacheOptions = {

package/dist/index.d.ts

@@ -28,6 +28,9 @@ declare class NodeCacheStore {
     del(key: string | number): Promise<boolean>;
     mdel(keys: Array<string | number>): Promise<boolean>;
     clear(): Promise<void>;
+    setTtl(key: string | number, ttl?: number): Promise<boolean>;
+    take<T>(key: string | number): Promise<T | undefined>;
+    disconnect(): Promise<void>;
 }
 
 type NodeCacheOptions = {

package/dist/index.js

@@ -91,6 +91,21 @@ var NodeCacheStore = class {
   async clear() {
     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);
+      return true;
+    }
+    return false;
+  }
+  async take(key) {
+    return this._cache.take(key.toString());
+  }
+  async disconnect() {
+    await this._cache.disconnect();
+  }
 };
 
 // src/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cacheable/node-cache",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Simple and Maintained fast NodeJS internal caching",
   "type": "module",
   "main": "./dist/index.cjs",