rate-limiter-flexible - npm Package Compare versions

Comparing version 0.8.0 to 0.8.1

package.json

 {
   "name": "rate-limiter-flexible",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Flexible API rate limiter backed by Redis for distributed node.js applications",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -227,5 +227,5 @@ [![Build Status](https://travis-ci.org/animir/node-rate-limiter-flexible.png)](https://travis-ci.org/animir/node-rate-limiter-flexible)
 Returns Promise, which: 
-* **resolved** when point(s) is consumed, so action can be done
+* **resolved** with `RateLimiterRes` when point(s) is consumed, so action can be done
 * only for RateLimiterRedis if `insuranceLimiter` isn't setup: **rejected** when some Redis error happened, where reject reason `rejRes` is Error object
-* only for RateLimiterCluster: **rejected** when `timeotMs` exceeded, where reject reason `rejRes` is Error object
+* only for RateLimiterCluster: **rejected** when `timeoutMs` exceeded, where reject reason `rejRes` is Error object
 * **rejected** when there is no points to be consumed, where reject reason `rejRes` is `RateLimiterRes` object
@@ -244,3 +244,7 @@ * **rejected** when key is blocked (if block strategy is set up), where reject reason `rejRes` is `RateLimiterRes` object
 
-Returns Promise, where result is consumed points in current duration
+Returns Promise, which: 
+* **resolved** with `RateLimiterRes`
+* only for RateLimiterRedis if `insuranceLimiter` isn't setup: 
+**rejected** when some Redis error happened, where reject reason `rejRes` is Error object
+* only for RateLimiterCluster: **rejected** when `timeotMs` exceeded, where reject reason `rejRes` is Error object
 
@@ -253,3 +257,7 @@ ### rateLimiter.reward(key, points = 1)
 
-Returns Promise, where result is consumed points in current duration
+Returns Promise, which: 
+* **resolved** with `RateLimiterRes`
+* only for RateLimiterRedis if `insuranceLimiter` isn't setup: 
+**rejected** when some Redis error happened, where reject reason `rejRes` is Error object
+* only for RateLimiterCluster: **rejected** when `timeotMs` exceeded, where reject reason `rejRes` is Error object
 
@@ -256,0 +264,0 @@ ## Contribution

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

120025

increased by0.47%

Number of lines in readme file

268

increased by3.08%

No dependency changes