rate-limiter-flexible 2.4.0 → 2.4.2

package/README.md

@@ -42,6 +42,18 @@ It uses **fixed window** as it is much faster than rolling window.
 
 `yarn add rate-limiter-flexible`
 
+## Import
+  
+  ```javascript
+  // CommonJS
+  const { RateLimiterMemory } = require("rate-limiter-flexible");
+
+  // or
+
+  // ECMAScript 
+  import { RateLimiterMemory } from "rate-limiter-flexible";
+  ```
+
 ## Basic Example
 
 Points can be consumed by IP address, user ID, authorisation token, API route or any other string.

package/lib/BurstyRateLimiter.js

@@ -17,9 +17,13 @@ module.exports = class BurstyRateLimiter {
    * @param {RateLimiterRes} [blRes] Bursty limiter response
    */
   _combineRes(rlRes, blRes) {
+    if (!rlRes) {
+      return null
+    }
+
     return new RateLimiterRes(
       rlRes.remainingPoints,
-      Math.min(rlRes.msBeforeNext, blRes.msBeforeNext),
+      Math.min(rlRes.msBeforeNext, blRes ? blRes.msBeforeNext : 0),
       rlRes.consumedPoints,
       rlRes.isFirstInDuration
     )

package/lib/index.d.ts

@@ -255,6 +255,10 @@ interface IRateLimiterMongoOptions extends IRateLimiterStoreOptions {
     };
 }
 
+interface IRateLimiterRedisOptions extends IRateLimiterStoreOptions {
+  rejectIfRedisNotReady?: boolean;
+}
+
 interface ICallbackReady {
     (error?: Error): void;
 }
@@ -284,7 +288,9 @@ export class RateLimiterClusterMasterPM2 {
     constructor(pm2: any);
 }
 
-export class RateLimiterRedis extends RateLimiterStoreAbstract {}
+export class RateLimiterRedis extends RateLimiterStoreAbstract {
+  constructor(opts: IRateLimiterRedisOptions);
+}
 
 export interface IRateLimiterMongoFunctionOptions {
     attrs: { [key: string]: any };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "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": {