@cacheable/node-cache 1.4.0 → 1.4.1

package/dist/index.js

@@ -24,36 +24,87 @@ var NodeCacheStore = class {
       }
     }
   }
+  /**
+   * Cacheable instance.
+   * @returns {Cacheable}
+   * @readonly
+   */
   get cache() {
     return this._cache;
   }
+  /**
+   * Time to live in milliseconds.
+   * @returns {number | string | undefined}
+   * @readonly
+   */
   get ttl() {
     return this._cache.ttl;
   }
+  /**
+   * Time to live in milliseconds.
+   * @param {number | string | undefined} ttl
+   */
   set ttl(ttl) {
     this._cache.ttl = ttl;
   }
+  /**
+   * Primary cache store.
+   * @returns {Keyv}
+   * @readonly
+   */
   get primary() {
     return this._cache.primary;
   }
+  /**
+   * Primary cache store.
+   * @param {Keyv} primary
+   */
   set primary(primary) {
     this._cache.primary = primary;
   }
+  /**
+   * Secondary cache store. Learn more about the secondary cache store in the
+   * [cacheable](https://github.com/jaredwray/cacheable/tree/main/packages/cacheable#storage-tiering-and-caching) documentation.
+   * @returns {Keyv | undefined}
+   */
   get secondary() {
     return this._cache.secondary;
   }
+  /**
+   * Secondary cache store. Learn more about the secondary cache store in the
+   * [cacheable](https://github.com/jaredwray/cacheable/tree/main/packages/cacheable#storage-tiering-and-caching) documentation.
+   * @param {Keyv | undefined} secondary
+   */
   set secondary(secondary) {
     this._cache.secondary = secondary;
   }
+  /**
+   * Maximum number of keys to store in the cache. if this is set to a value greater than 0,
+   * the cache will keep track of the number of keys and will not store more than the specified number of keys.
+   * @returns {number}
+   * @readonly
+   */
   get maxKeys() {
     return this._maxKeys;
   }
+  /**
+   * Maximum number of keys to store in the cache. if this is set to a value greater than 0,
+   * the cache will keep track of the number of keys and will not store more than the specified number of keys.
+   * @param {number} maxKeys
+   */
   set maxKeys(maxKeys) {
     this._maxKeys = maxKeys;
     if (this._maxKeys > 0) {
       this._cache.stats.enabled = true;
     }
   }
+  /**
+   * Set a key/value pair in the cache.
+   * @param {string | number} key
+   * @param {any} value
+   * @param {number} [ttl]
+   * @returns {boolean}
+   */
   async set(key, value, ttl) {
     if (this._maxKeys > 0) {
       if (this._cache.stats.count >= this._maxKeys) {
@@ -63,6 +114,11 @@ var NodeCacheStore = class {
     await this._cache.set(key.toString(), value, ttl);
     return true;
   }
+  /**
+   * Set multiple key/value pairs in the cache.
+   * @param {NodeCacheItem[]} list
+   * @returns {void}
+   */
   async mset(list) {
     const items = new Array();
     for (const item of list) {
@@ -70,9 +126,19 @@ var NodeCacheStore = class {
     }
     await this._cache.setMany(items);
   }
+  /**
+   * Get a value from the cache.
+   * @param {string | number} key
+   * @returns {any | undefined}
+   */
   async get(key) {
     return this._cache.get(key.toString());
   }
+  /**
+   * Get multiple values from the cache.
+   * @param {Array<string | number>} keys
+   * @returns {Record<string, any | undefined>}
+   */
   async mget(keys) {
     const result = {};
     for (const key of keys) {
@@ -80,15 +146,34 @@ var NodeCacheStore = class {
     }
     return result;
   }
+  /**
+   * Delete a key from the cache.
+   * @param {string | number} key
+   * @returns {boolean}
+   */
   async del(key) {
     return this._cache.delete(key.toString());
   }
+  /**
+   * Delete multiple keys from the cache.
+   * @param {Array<string | number>} keys
+   * @returns {boolean}
+   */
   async mdel(keys) {
     return this._cache.deleteMany(keys.map((key) => key.toString()));
   }
+  /**
+   * Clear the cache.
+   * @returns {void}
+   */
   async clear() {
     return this._cache.clear();
   }
+  /**
+   * Check if a key exists in the cache.
+   * @param {string | number} key
+   * @returns {boolean}
+   */
   async setTtl(key, ttl) {
     const item = await this._cache.get(key.toString());
     if (item) {
@@ -97,9 +182,18 @@ var NodeCacheStore = class {
     }
     return false;
   }
+  /**
+   * Check if a key exists in the cache. If it does exist it will get the value and delete the item from the cache.
+   * @param {string | number} key
+   * @returns {any | undefined}
+   */
   async take(key) {
     return this._cache.take(key.toString());
   }
+  /**
+   * Disconnect from the cache.
+   * @returns {void}
+   */
   async disconnect() {
     await this._cache.disconnect();
   }
@@ -133,7 +227,13 @@ var NodeCache = class extends eventemitter {
     }
     this.startInterval();
   }
-  // Sets a key value pair. It is possible to define a ttl (in seconds). Returns true on success.
+  /**
+   * 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
+   * @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);
@@ -160,7 +260,11 @@ var NodeCache = class extends eventemitter {
     this._stats.setCount(this.store.size);
     return true;
   }
-  // Sets multiple key val pairs. It is possible to define a ttl (seconds). Returns true on success.
+  /**
+   * 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
+   * @returns {boolean}
+   */
   mset(data) {
     if (!Array.isArray(data)) {
       throw this.createError("The keys argument has to be an array." /* EKEYSTYPE */);
@@ -170,7 +274,11 @@ var NodeCache = class extends eventemitter {
     }
     return true;
   }
-  // Gets a saved value from the cache. Returns a undefined if not found or expired. If the value was found it returns the value.
+  /**
+   * Gets a saved value from the cache. Returns a undefined if not found or expired. If the value was found it returns the value.
+   * @param {string | number} key if the key is a number it will convert it to a string
+   * @returns {T} the value or undefined
+   */
   get(key) {
     const result = this.store.get(this.formatKey(key));
     if (result) {
@@ -198,10 +306,12 @@ var NodeCache = class extends eventemitter {
     this._stats.incrementMisses();
     return void 0;
   }
-  /*
-  	Gets multiple saved values from the cache. Returns an empty object {} if not found or expired.
-  	If the value was found it returns an object with the key value pair.
-  */
+  /**
+   * Gets multiple saved values from the cache. Returns an empty object {} if not found or expired.
+   * If the value was found it returns an object with the key value pair.
+   * @param {Array<string | number} keys an array of keys
+   * @returns {Record<string, unknown>} an object with the key as a property and the value as the value
+   */
   mget(keys) {
     const result = {};
     for (const key of keys) {
@@ -212,11 +322,12 @@ var NodeCache = class extends eventemitter {
     }
     return result;
   }
-  /*
-  	Get the cached value and remove the key from the cache.
-  	Equivalent to calling get(key) + del(key).
-  	Useful for implementing single use mechanism such as OTP, where once a value is read it will become obsolete.
-  */
+  /**
+   * Get the cached value and remove the key from the cache. Equivalent to calling get(key) + del(key).
+   * Useful for implementing single use mechanism such as OTP, where once a value is read it will become obsolete.
+   * @param {string | number} key
+   * @returns {T | undefined} the value or undefined
+   */
   take(key) {
     const result = this.get(key);
     if (result) {
@@ -228,7 +339,11 @@ var NodeCache = class extends eventemitter {
     }
     return void 0;
   }
-  // Delete a key. Returns the number of deleted entries. A delete will never fail.
+  /**
+   * Delete a key. Returns the number of deleted entries. A delete will never fail.
+   * @param {string | number | Array<string | number>} key if the key is a number it will convert it to a string. if an array is passed it will delete all keys in the array.
+   * @returns {number} if it was successful it will return the count that was deleted
+   */
   del(key) {
     if (Array.isArray(key)) {
       return this.mdel(key);
@@ -245,7 +360,11 @@ var NodeCache = class extends eventemitter {
     }
     return 0;
   }
-  // Delete all keys in Array that exist. Returns the number of deleted entries.
+  /**
+   * Delete all keys in Array that exist. Returns the number of deleted entries.
+   * @param {Array<string | number>} keys an array of keys
+   * @returns {number} the count of deleted keys
+   */
   mdel(keys) {
     let result = 0;
     for (const key of keys) {
@@ -253,8 +372,13 @@ var NodeCache = class extends eventemitter {
     }
     return result;
   }
-  // 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.
+  /**
+   * 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
+   * @returns {boolean} true if the key has been found and changed. Otherwise returns false.
+   */
   ttl(key, ttl) {
     const result = this.store.get(this.formatKey(key));
     if (result) {
@@ -265,13 +389,12 @@ var NodeCache = class extends eventemitter {
     }
     return false;
   }
-  /*
-  		Receive the ttl of a key. You will get:
-  
-  		undefined if the key does not exist
-  		0 if this key has no ttl
-  		a timestamp in ms representing the time at which the key will expire
-  	*/
+  /**
+   * Receive the ttl of a key.
+   * @param {string | number} key if the key is a number it will convert it to a string
+   * @returns {number | undefined} 0 if this key has no ttl, undefined if this key is not in the cache,
+   * a timestamp in ms representing the time at which this key will expire
+   */
   getTtl(key) {
     const result = this.store.get(this.formatKey(key));
     if (result) {
@@ -282,10 +405,10 @@ var NodeCache = class extends eventemitter {
     }
     return void 0;
   }
-  /*
-  	Returns an array of all existing keys.
-  	[ "all", "my", "keys", "foo", "bar" ]
-  */
+  /**
+   * Returns an array of all existing keys. [ "all", "my", "keys", "foo", "bar" ]
+   * @returns {string[]} an array of all keys
+   */
   keys() {
     const result = [];
     for (const key of this.store.keys()) {
@@ -293,11 +416,18 @@ var NodeCache = class extends eventemitter {
     }
     return result;
   }
-  // Returns boolean indicating if the key is cached.
+  /**
+   * Returns boolean indicating if the key is cached.
+   * @param {string | number} key if the key is a number it will convert it to a string
+   * @returns {boolean} true if the key is cached
+   */
   has(key) {
     return this.store.has(this.formatKey(key));
   }
-  // Gets the stats of the cache.
+  /**
+   * Gets the stats of the cache
+   * @returns {NodeCacheStats} the stats of the cache
+   */
   getStats() {
     const stats = {
       keys: this._stats.count,
@@ -308,22 +438,34 @@ var NodeCache = class extends eventemitter {
     };
     return stats;
   }
-  // Flush the whole data.
+  /**
+   * Flush the whole data.
+   * @returns {void}
+   */
   flushAll() {
     this.store.clear();
     this.flushStats();
     this.emit("flush");
   }
-  // Flush the stats
+  /**
+   * Flush the stats.
+   * @returns {void}
+   */
   flushStats() {
     this._stats = new CacheableStats({ enabled: true });
     this.emit("flush_stats");
   }
-  // Close the cache. This will clear the interval timeout which is set on check period option.
+  /**
+   * Close the cache. This will clear the interval timeout which is set on check period option.
+   * @returns {void}
+   */
   close() {
     this.stopInterval();
   }
-  // Get the interval id
+  /**
+   * Get the interval id
+   * @returns {number | NodeJS.Timeout} the interval id
+   */
   getIntervalId() {
     return this.intervalId;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cacheable/node-cache",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Simple and Maintained fast NodeJS internal caching",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -12,7 +12,11 @@
       "import": "./dist/index.js"
     }
   },
-  "repository": "https://github.com/jaredwray/cacheable.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jaredwray/cacheable.git",
+    "directory": "packages/node-cache"
+  },
   "author": "Jared Wray <me@jaredwray.com>",
   "license": "MIT",
   "private": false,
@@ -27,18 +31,18 @@
     "cacheable-node"
   ],
   "devDependencies": {
-    "@types/node": "^22.7.4",
-    "@vitest/coverage-v8": "^2.1.1",
+    "@types/node": "^22.8.1",
+    "@vitest/coverage-v8": "^2.1.3",
     "rimraf": "^6.0.1",
-    "tsup": "^8.3.0",
-    "typescript": "^5.6.2",
-    "vitest": "^2.1.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.3",
     "xo": "^0.59.3"
   },
   "dependencies": {
-    "cacheable": "^1.7.0",
+    "cacheable": "^1.8.1",
     "eventemitter3": "^5.0.1",
-    "keyv": "^5.0.3"
+    "keyv": "^5.1.2"
   },
   "files": [
     "dist",