add option to allow custom param name added to req

express-rate-limit · Jul 22, 2021 · c668c26 · c668c26
1 parent c4f9c46
commit c668c26
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,8 @@ app.post("/create-account", createAccountLimiter, function(req, res) {
 
 A `req.rateLimit` property is added to all requests with the `limit`, `current`, and `remaining` number of requests and, if the store provides it, a `resetTime` Date object. These may be used in your application code to take additional actions or inform the user of their status.
 
+The property name can be configured with the configuration option `reqRateLimitParam`
+
 ## Configuration options
 
 ### max
@@ -230,6 +232,11 @@ function (/*req, res*/) {
 }
 ```
 
+### reqRateLimitParam
+Parameter to add to `req`-Object. 
+
+Defaults to `rateLimit`.
+
 ### store
 
 The storage to use when persisting rate limit attempts.
@@ -314,4 +321,4 @@ v2 uses a less precise but less resource intensive method of tracking hits from
 
 ## License
 
-MIT © [Nathan Friedly](http://nfriedly.com/)
+MIT © [Nathan Friedly](http://nfriedly.com/)
diff --git a/lib/express-rate-limit.js b/lib/express-rate-limit.js
@@ -27,6 +27,7 @@ function RateLimit(options) {
         res.status(options.statusCode).send(options.message);
       },
       onLimitReached: function (/*req, res, optionsUsed*/) {},
+      reqRateLimitParam: "rateLimit", // Parameter name appended to req object
     },
     options
   );
@@ -74,7 +75,7 @@ function RateLimit(options) {
 
           Promise.resolve(maxResult)
             .then((max) => {
-              req.rateLimit = {
+              req[options.reqRateLimitParam] = {
                 limit: max,
                 current: current,
                 remaining: Math.max(max - current, 0),
@@ -83,7 +84,7 @@ function RateLimit(options) {
 
               if (options.headers && !res.headersSent) {
                 res.setHeader("X-RateLimit-Limit", max);
-                res.setHeader("X-RateLimit-Remaining", req.rateLimit.remaining);
+                res.setHeader("X-RateLimit-Remaining", req[options.reqRateLimitParam].remaining);
                 if (resetTime instanceof Date) {
                   // if we have a resetTime, also provide the current date to help avoid issues with incorrect clocks
                   res.setHeader("Date", new Date().toUTCString());
@@ -95,7 +96,7 @@ function RateLimit(options) {
               }
               if (options.draft_polli_ratelimit_headers && !res.headersSent) {
                 res.setHeader("RateLimit-Limit", max);
-                res.setHeader("RateLimit-Remaining", req.rateLimit.remaining);
+                res.setHeader("RateLimit-Remaining", req[options.reqRateLimitParam].remaining);
                 if (resetTime) {
                   const deltaSeconds = Math.ceil(
                     (resetTime.getTime() - Date.now()) / 1000
@@ -175,4 +176,4 @@ function RateLimit(options) {
   return rateLimit;
 }
 
-module.exports = RateLimit;
+module.exports = RateLimit;