express-rate-limit 6.5.2 → 6.6.0

package/dist/index.cjs

@@ -37,12 +37,11 @@ var MemoryStore = class {
     this.windowMs = options.windowMs;
     this.resetTime = calculateNextResetTime(this.windowMs);
     this.hits = {};
-    const interval = setInterval(async () => {
+    this.interval = setInterval(async () => {
       await this.resetAll();
     }, this.windowMs);
-    if (interval.unref) {
-      interval.unref();
-    }
+    if (this.interval.unref)
+      this.interval.unref();
   }
   async increment(key) {
     var _a;
@@ -55,9 +54,8 @@ var MemoryStore = class {
   }
   async decrement(key) {
     const current = this.hits[key];
-    if (current) {
+    if (current)
       this.hits[key] = current - 1;
-    }
   }
   async resetKey(key) {
     delete this.hits[key];
@@ -66,6 +64,9 @@ var MemoryStore = class {
     this.hits = {};
     this.resetTime = calculateNextResetTime(this.windowMs);
   }
+  shutdown() {
+    clearInterval(this.interval);
+  }
 };
 
 // source/lib.ts

package/dist/index.d.ts

@@ -126,6 +126,10 @@ export interface Store {
 	 * Method to reset everyone's hit counter.
 	 */
 	resetAll?: () => Promise<void> | void;
+	/**
+	 * Method to shutdown the store, stop timers, and release all resources.
+	 */
+	shutdown?: () => Promise<void> | void;
 }
 /**
  * The configuration options for the rate limiter.
@@ -297,6 +301,10 @@ export declare class MemoryStore implements Store {
 	 * The time at which all hit counts will be reset.
 	 */
 	resetTime: Date;
+	/**
+	 * Reference to the active timer.
+	 */
+	interval?: NodeJS.Timer;
 	/**
 	 * Method that initializes the store.
 	 *
@@ -335,6 +343,13 @@ export declare class MemoryStore implements Store {
 	 * @public
 	 */
 	resetAll(): Promise<void>;
+	/**
+	 * Method to stop the timer (if currently running) and prevent any memory
+	 * leaks.
+	 *
+	 * @public
+	 */
+	shutdown(): void;
 }
 
 export {

package/dist/index.mjs

@@ -9,12 +9,11 @@ var MemoryStore = class {
     this.windowMs = options.windowMs;
     this.resetTime = calculateNextResetTime(this.windowMs);
     this.hits = {};
-    const interval = setInterval(async () => {
+    this.interval = setInterval(async () => {
       await this.resetAll();
     }, this.windowMs);
-    if (interval.unref) {
-      interval.unref();
-    }
+    if (this.interval.unref)
+      this.interval.unref();
   }
   async increment(key) {
     var _a;
@@ -27,9 +26,8 @@ var MemoryStore = class {
   }
   async decrement(key) {
     const current = this.hits[key];
-    if (current) {
+    if (current)
       this.hits[key] = current - 1;
-    }
   }
   async resetKey(key) {
     delete this.hits[key];
@@ -38,6 +36,9 @@ var MemoryStore = class {
     this.hits = {};
     this.resetTime = calculateNextResetTime(this.windowMs);
   }
+  shutdown() {
+    clearInterval(this.interval);
+  }
 };
 
 // source/lib.ts

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "6.5.2",
+	"version": "6.6.0",
 	"description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.",
 	"author": {
 		"name": "Nathan Friedly",