express-rate-limit 5.4.1 → 5.5.0

package/README.md

@@ -187,14 +187,14 @@ function (req /*, res*/) {
 
 ### handler
 
-The function to handle requests once the max limit is exceeded. It receives the request and the response objects. The "next" param is available if you need to pass to the next middleware.
+The function to handle requests once the max limit is exceeded. It receives the request and the response objects. The "next" param is available if you need to pass to the next middleware. Finally, the options param has all of the options that originally passed in when creating the current limiter and the default values for other options.
 
 The`req.rateLimit` object has `limit`, `current`, and `remaining` number of requests and, if the store provides it, a `resetTime` Date object.
 
 Defaults to:
 
 ```js
-function (req, res, /*next*/) {
+function (req, res, next, options) {
     res.status(options.statusCode).send(options.message);
 }
 ```

package/lib/express-rate-limit.js

@@ -28,7 +28,7 @@ function RateLimit(options) {
       skip: function (/*req, res*/) {
         return false;
       },
-      handler: function (req, res /*, next*/) {
+      handler: function (req, res /*, next, optionsUsed*/) {
         res.status(options.statusCode).send(options.message);
       },
       onLimitReached: function (/*req, res, optionsUsed*/) {},
@@ -164,7 +164,7 @@ function RateLimit(options) {
                     Math.ceil(options.windowMs / 1000)
                   );
                 }
-                return options.handler(req, res, next);
+                return options.handler(req, res, next, options);
               }
 
               next();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-rate-limit",
-  "version": "5.4.1",
+  "version": "5.5.0",
   "description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.",
   "homepage": "https://github.com/nfriedly/express-rate-limit",
   "author": {