leaky-bucket - npm Package Compare versions

Comparing version 4.1.2 to 4.1.3

package.json

 {
     "name": "leaky-bucket",
     "description": "A fast and efficient leaky bucket implementation",
-    "version": "4.1.2",
+    "version": "4.1.3",
     "homepage": "https://github.com/linaGirl/leaky-bucket",
@@ -6,0 +6,0 @@ "author": "Lina van der Weg <[e-mail]> (http://vanderweg.ch/)",

README.md

@@ -225,3 +225,2 @@ # leaky-bucket
     interval: 60,
-    idleTimeout: 2000,
 });
@@ -247,4 +246,2 @@
     interval: 60,
-    idleTimeout: 2000,
-});
 
@@ -259,5 +256,26 @@ bucket.on('idle', (bucketInstance) => {
 
+### bucket.off(eventName, optional handler)
 
+Removes all or one listeners for an event
 
+```javascript
+const bucket = new Bucket({
+    capacity: 60,
+    interval: 60,
+});
 
+// remove all listeners for the idle event
+bucket.off('idle')
+
+const listener = (bucketInstance) => {
+    console.log(bucketInstance.getCurrentCapacity());
+}
+
+bucket.on('idle', listener);
+
+// remove one specific listener
+bucket.off('idle', listener);
+````
+
+
 ## Browser
@@ -264,0 +282,0 @@

No alert changes

Improved metrics

Total package byte prevSize

39371

increased by0.96%

Number of lines in readme file

354

increased by5.36%

No dependency changes