rate-limiter-flexible 2.3.7 → 2.3.8

package/README.md

@@ -42,6 +42,8 @@ It uses **fixed window** as it is much faster than rolling window.
 
 ## Basic Example
 
+Points can be consumed by IP address, user ID, authorisation token, API route or any other string.
+
 ```javascript
 const opts = {
   points: 6, // 6 points

package/lib/RateLimiterMemory.js

@@ -48,7 +48,7 @@ class RateLimiterMemory extends RateLimiterAbstract {
     return new Promise((resolve) => {
       const secDuration = this._getKeySecDuration(options);
       const res = this._memoryStorage.incrby(rlKey, points, secDuration);
-      res.remainingPoints = this.points - res.consumedPoints;
+      res.remainingPoints = Math.max(this.points - res.consumedPoints, 0);
       resolve(res);
     });
   }
@@ -58,7 +58,7 @@ class RateLimiterMemory extends RateLimiterAbstract {
     return new Promise((resolve) => {
       const secDuration = this._getKeySecDuration(options);
       const res = this._memoryStorage.incrby(rlKey, -points, secDuration);
-      res.remainingPoints = this.points - res.consumedPoints;
+      res.remainingPoints = Math.max(this.points - res.consumedPoints, 0);
       resolve(res);
     });
   }
@@ -91,7 +91,7 @@ class RateLimiterMemory extends RateLimiterAbstract {
   get(key) {
     const res = this._memoryStorage.get(this.getKey(key));
     if (res !== null) {
-      res.remainingPoints = this.points - res.consumedPoints;
+      res.remainingPoints = Math.max(this.points - res.consumedPoints, 0);
     }
 
     return Promise.resolve(res);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "2.3.7",
+  "version": "2.3.8",
   "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",
   "main": "index.js",
   "scripts": {