version bump, changelog and docs

patrickkunka · Jun 26, 2020 · 9f65373 · 9f65373
1 parent 838543f
commit 9f65373
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+# 1.1.1
+- Fixes an issue where the throttle ended early with incomplete throughput, if the incoming data rate slows such that the outgoing data must wait.
+
 # 1.1.0
 - Fixes issues when passing requests through an unbounded throttle (`bytesPerSecond` = `Infinity`).
 - Adds public `onThroughputMetrics` metrics callback to the `BandwidthThrottleGroup`.

diff --git a/lib/BandwidthThrottle.ts b/lib/BandwidthThrottle.ts
@@ -125,8 +125,10 @@ class BandwidthThrottle extends BaseTransformStream {
             }
         }
 
-        // if data is still being written and processed, or there is no pending data but we are
-        // unthrottled, stop here
+        // Do not complete if:
+        // - additional data is available to be processed,
+        // - or, no additional data is available, but not all data has been written yet
+        // - or, we are unthrottled
 
         if (
             this.pendingBytesReadIndex < this.pendingBytesCount ||

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "bandwidth-throttle-stream",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "description": "A Node.js and Deno transform stream for throttling bandwidth",
     "author": "KunkaLabs Limited",
     "private": false,