nestjs-rate-limiter - npm Package Compare versions

Comparing version 2.5.6 to 2.6.0-alpha

dist/default-options.js

@@ -28,3 +28,4 @@ "use strict";
     maxQueueSize: 100,
-    errorMessage: 'Rate limit exceeded'
+    errorMessage: 'Rate limit exceeded',
+    limiterKey: undefined
 };

dist/rate-limiter.interceptor.js

@@ -163,3 +163,3 @@ "use strict";
             const rateLimiter = yield this.getRateLimiter(reflectedOptions);
-            const key = request.ip.replace(/^.*:/, '');
+            const key = this.options.limiterKey || request.ip.replace(/^.*:/, '');
             yield this.responseHandler(response, key, rateLimiter, points, pointsConsumed);
@@ -166,0 +166,0 @@ return next.handle();

dist/rate-limiter.interface.d.ts

@@ -28,2 +28,3 @@ import { Provider } from '@nestjs/common';
     errorMessage?: string;
+    limiterKey?: string;
 }
@@ -30,0 +31,0 @@ export interface RateLimiterOptionsFactory {

package.json

 {
   "name": "nestjs-rate-limiter",
-  "version": "2.5.6",
+  "version": "2.6.0-alpha",
   "description": "Highly configurable rate limiter library",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -421,2 +421,10 @@ <p align="center">
 
+#### ● limiterKey
+  <code> Default: Client's Ip Address </code>
+  <br>
+  <code> Type: string</code>
+  <br>
+
+  limiterKey option allows you to control scenarios such as applying rate limiter based on User Account instead of Ip Address
+
 # Benchmarks
@@ -423,0 +431,0 @@

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39998

0.81%

Lines of code

426

0.47%

Number of lines in readme file

452

1.8%

Worsened metrics

Number of low quality alerts

1

Infinity%

No dependency changes