rate-limiter-flexible - npm Package Compare versions

Comparing version 2.2.4 to 2.3.0

lib/component/BlockedKeys/BlockedKeys.js

@@ -60,2 +60,17 @@ module.exports = class BlockedKeys {
   }
+
+  /**
+   * If key is not given, delete all data in memory
+   * 
+   * @param {string|undefined} key
+   */
+  delete(key) {
+    if (key) {
+      delete this._keys[key];
+    } else {
+      Object.keys(this._keys).forEach((key) => {
+        delete this._keys[key];
+      });
+    }
+  }
 };

lib/RateLimiterStoreAbstract.js

@@ -287,2 +287,3 @@ const RateLimiterAbstract = require('./RateLimiterAbstract');
         .then((res) => {
+          this._inmemoryBlockedKeys.delete(rlKey);
           resolve(res);
@@ -297,2 +298,9 @@ })
   /**
+   * Cleanup keys no-matter expired or not.
+   */
+  deleteInMemoryBlockedAll() {
+    this._inmemoryBlockedKeys.delete();
+  }
+
+  /**
    * Get RateLimiterRes object filled depending on storeResult, which specific for exact store
@@ -361,2 +369,19 @@ *
   }
+
+  /**
+   * Have to be implemented
+   * Resolve with object used for {@link _getRateLimiterRes} to generate {@link RateLimiterRes}
+   *
+   * @param {string} rlKey
+   * @param {number} points
+   * @param {number} msDuration
+   * @param {boolean} forceExpire
+   * @param {Object} options
+   * @abstract
+   *
+   * @return Promise<Object>
+   */
+  _upsert() {
+    throw new Error("You have to implement the method '_upsert'!");
+  }
 };

package.json

 {
   "name": "rate-limiter-flexible",
-  "version": "2.2.4",
+  "version": "2.3.0",
   "description": "Node.js rate limiter by key and protection from DDoS and Brute-Force attacks in process Memory, Redis, MongoDb, Memcached, MySQL, PostgreSQL, Cluster or PM",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -187,2 +187,3 @@ [![Build Status](https://travis-ci.org/animir/node-rate-limiter-flexible.png)](https://travis-ci.org/animir/node-rate-limiter-flexible)
 * [delete(key)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterdeletekey) Reset consumed points.
+* [deleteInMemoryBlockedAll](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterdeleteinmemoryblockedall)
 * [penalty(key, points = 1)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterpenaltykey-points--1) Increase number of consumed points in current duration.
@@ -189,0 +190,0 @@ * [reward(key, points = 1)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterrewardkey-points--1) Decrease number of consumed points in current duration.

No alert changes

Improved metrics

Total package byte prevSize

119114

increased by0.87%

Lines of code

3249

increased by1.15%

Number of lines in readme file

233

increased by0.43%

No dependency changes