rate-limiter-flexible 2.3.6 → 2.3.9

package/README.md

@@ -1,4 +1,3 @@
-[![Build Status](https://travis-ci.org/animir/node-rate-limiter-flexible.png)](https://travis-ci.org/animir/node-rate-limiter-flexible)
 [![Coverage Status](https://coveralls.io/repos/animir/node-rate-limiter-flexible/badge.svg?branch=master)](https://coveralls.io/r/animir/node-rate-limiter-flexible?branch=master)
 [![npm version](https://badge.fury.io/js/rate-limiter-flexible.svg)](https://www.npmjs.com/package/rate-limiter-flexible)
 ![npm](https://img.shields.io/npm/dm/rate-limiter-flexible.svg)
@@ -43,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/lib/index.d.ts

@@ -237,6 +237,10 @@ interface IRateLimiterStoreOptions extends IRateLimiterOptions {
     tableCreated?: boolean;
 }
 
+interface IRateLimiterStoreNoAutoExpiryOptions extends IRateLimiterStoreOptions {
+    clearExpiredByTimeout?: boolean;
+}
+
 interface IRateLimiterMongoOptions extends IRateLimiterStoreOptions {
     indexKeyPrefix?: {
         [key: string]: any;
@@ -326,11 +330,11 @@ export class RateLimiterMongo extends RateLimiterStoreAbstract {
 }
 
 export class RateLimiterMySQL extends RateLimiterStoreAbstract {
-    constructor(opts: IRateLimiterStoreOptions, cb?: ICallbackReady);
+    constructor(opts: IRateLimiterStoreNoAutoExpiryOptions, cb?: ICallbackReady);
 }
 
 export class RateLimiterPostgres extends RateLimiterStoreAbstract {
-    constructor(opts: IRateLimiterStoreOptions, cb?: ICallbackReady);
+    constructor(opts: IRateLimiterStoreNoAutoExpiryOptions, cb?: ICallbackReady);
 }
 
 export class RateLimiterMemcache extends RateLimiterStoreAbstract {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "2.3.6",
+  "version": "2.3.9",
   "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": {
@@ -51,5 +51,9 @@
     "mocha": "^5.1.1",
     "redis-mock": "^0.48.0",
     "sinon": "^5.0.10"
+  },
+  "browser": {
+    "cluster": false,
+    "crypto": false
   }
 }