@cacheable/node-cache 1.5.1 → 1.5.3

package/README.md

@@ -141,7 +141,7 @@ export type NodeCacheOptions = {
 	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.
+	deleteOnExpire?: boolean; // Default is true, if false it will keep the key and not delete during an interval check and the value on get() will be undefined
 	maxKeys?: number; // Default is -1 (unlimited). If this is set it will throw and error if you try to set more keys than the max.
 };
 ```

package/dist/index.cjs

@@ -18,14 +18,14 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   NodeCache: () => NodeCache,
   NodeCacheErrors: () => NodeCacheErrors,
   NodeCacheStore: () => NodeCacheStore,
-  default: () => src_default
+  default: () => index_default
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 var import_cacheable2 = require("cacheable");
 var import_hookified2 = require("hookified");
 
@@ -530,7 +530,10 @@ var NodeCache = class extends import_hookified2.Hookified {
   checkData() {
     for (const [key, value] of this.store.entries()) {
       if (value.ttl > 0 && value.ttl < Date.now()) {
-        this.del(key);
+        if (this.options.deleteOnExpire) {
+          this.del(key);
+        }
+        this.emit("expired", this.formatKey(key), value.value);
       }
     }
   }
@@ -548,7 +551,7 @@ var NodeCache = class extends import_hookified2.Hookified {
     return new Error(error);
   }
 };
-var src_default = NodeCache;
+var index_default = NodeCache;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NodeCache,

package/dist/index.d.cts

@@ -158,7 +158,7 @@ type NodeCacheOptions = {
      */
     useClones?: boolean;
     /**
-     * Delete all expired items at the set interval. Default is true.
+     * Delete expired items during an interval check or a single item on a get request. Default is true.
      */
     deleteOnExpire?: boolean;
     /**

package/dist/index.d.ts

@@ -158,7 +158,7 @@ type NodeCacheOptions = {
      */
     useClones?: boolean;
     /**
-     * Delete all expired items at the set interval. Default is true.
+     * Delete expired items during an interval check or a single item on a get request. Default is true.
      */
     deleteOnExpire?: boolean;
     /**

package/dist/index.js

@@ -503,7 +503,10 @@ var NodeCache = class extends Hookified2 {
   checkData() {
     for (const [key, value] of this.store.entries()) {
       if (value.ttl > 0 && value.ttl < Date.now()) {
-        this.del(key);
+        if (this.options.deleteOnExpire) {
+          this.del(key);
+        }
+        this.emit("expired", this.formatKey(key), value.value);
       }
     }
   }
@@ -521,10 +524,10 @@ var NodeCache = class extends Hookified2 {
     return new Error(error);
   }
 };
-var src_default = NodeCache;
+var index_default = NodeCache;
 export {
   NodeCache,
   NodeCacheErrors,
   NodeCacheStore,
-  src_default as default
+  index_default as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cacheable/node-cache",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "Simple and Maintained fast NodeJS internal caching",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -31,18 +31,18 @@
     "cacheable-node"
   ],
   "devDependencies": {
-    "@types/node": "^22.8.1",
-    "@vitest/coverage-v8": "^2.1.3",
+    "@types/node": "^22.13.9",
+    "@vitest/coverage-v8": "^3.0.7",
     "rimraf": "^6.0.1",
-    "tsup": "^8.3.5",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.3",
-    "xo": "^0.59.3"
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.7",
+    "xo": "^0.60.0"
   },
   "dependencies": {
-    "cacheable": "^1.8.1",
-    "hookified": "^1.5.1",
-    "keyv": "^5.2.1"
+    "hookified": "^1.7.1",
+    "keyv": "^5.3.1",
+    "cacheable": "^1.8.9"
   },
   "files": [
     "dist",
@@ -50,6 +50,7 @@
   ],
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
+    "prepublish": "pnpm build",
     "test": "xo --fix && vitest run --coverage",
     "test:ci": "xo && vitest run",
     "clean": "rimraf ./dist ./coverage ./node_modules"