stream: add writableAborted

PR-URL: #40802 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Nov 18, 2021 · 415726b · 415726b
1 parent aa394ab
commit 415726b
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 0 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -596,6 +596,18 @@ added: v11.4.0
 Is `true` if it is safe to call [`writable.write()`][stream-write], which means
 the stream has not been destroyed, errored or ended.
 
+##### `writable.writableAborted`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+* {boolean}
+
+Returns whether the stream was destroyed or errored before emitting `'finish'`.
+
 ##### `writable.writableEnded`
 
 <!-- YAML

diff --git a/lib/internal/streams/writable.js b/lib/internal/streams/writable.js
@@ -864,6 +864,17 @@ ObjectDefineProperties(Writable.prototype, {
       return this._writableState ? this._writableState.errored : null;
     }
   },
+
+  writableAborted: {
+    enumerable: false,
+    get: function() {
+      return !!(
+        this._writableState.writable !== false &&
+        (this._writableState.destroyed || this._writableState.errored) &&
+        !this._writableState.finished
+      );
+    }
+  },
 });
 
 const destroy = destroyImpl.destroy;

diff --git a/test/parallel/test-stream-writable-aborted.js b/test/parallel/test-stream-writable-aborted.js
@@ -0,0 +1,26 @@
+'use strict';
+
+require('../common');
+const assert = require('assert');
+const { Writable } = require('stream');
+
+{
+  const writable = new Writable({
+    write() {
+    }
+  });
+  assert.strictEqual(writable.writableAborted, false);
+  writable.destroy();
+  assert.strictEqual(writable.writableAborted, true);
+}
+
+{
+  const writable = new Writable({
+    write() {
+    }
+  });
+  assert.strictEqual(writable.writableAborted, false);
+  writable.end();
+  writable.destroy();
+  assert.strictEqual(writable.writableAborted, true);
+}