stream: unify writableErrored and readableErrored

ronag · ronag · commit 340b770d3f4c · 2021-11-18T14:31:43.000+01:00
Both of these should always refer to the same error, hence there is no reason to separate them. PR-URL: #40799 Refs: #40696 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -633,7 +633,7 @@ added:
 Number of times [`writable.uncork()`][stream-uncork] needs to be
 called in order to fully uncork the stream.
 
-##### `writable.writableErrored`
+##### `writable.errored`
 
 <!-- YAML
 added:
@@ -1389,7 +1389,7 @@ added: v12.9.0
 
 Becomes `true` when [`'end'`][] event is emitted.
 
-##### `readable.readableErrored`
+##### `readable.errored`
 
 <!-- YAML
 added:
diff --git a/lib/internal/streams/readable.js b/lib/internal/streams/readable.js
@@ -1242,7 +1242,7 @@ ObjectDefineProperties(Readable.prototype, {
     }
   },
 
-  readableErrored: {
+  errored: {
     enumerable: false,
     get() {
       return this._readableState ? this._readableState.errored : null;
diff --git a/lib/internal/streams/writable.js b/lib/internal/streams/writable.js
@@ -858,7 +858,7 @@ ObjectDefineProperties(Writable.prototype, {
     }
   },
 
-  writableErrored: {
+  errored: {
     enumerable: false,
     get() {
       return this._writableState ? this._writableState.errored : null;
diff --git a/test/parallel/test-stream-finished.js b/test/parallel/test-stream-finished.js
@@ -612,7 +612,7 @@ testClosed((opts) => new Writable({ write() {}, ...opts }));
   const w = new Writable();
   const _err = new Error();
   w.destroy(_err);
-  assert.strictEqual(w.writableErrored, _err);
+  assert.strictEqual(w.errored, _err);
   finished(w, common.mustCall((err) => {
     assert.strictEqual(_err, err);
     assert.strictEqual(w.closed, true);
@@ -625,7 +625,7 @@ testClosed((opts) => new Writable({ write() {}, ...opts }));
 {
   const w = new Writable();
   w.destroy();
-  assert.strictEqual(w.writableErrored, null);
+  assert.strictEqual(w.errored, null);
   finished(w, common.mustCall((err) => {
     assert.strictEqual(w.closed, true);
     assert.strictEqual(err.code, 'ERR_STREAM_PREMATURE_CLOSE');
diff --git a/test/parallel/test-stream-readable-destroy.js b/test/parallel/test-stream-readable-destroy.js
@@ -13,7 +13,7 @@ const assert = require('assert');
   read.on('close', common.mustCall());
 
   read.destroy();
-  assert.strictEqual(read.readableErrored, null);
+  assert.strictEqual(read.errored, null);
   assert.strictEqual(read.destroyed, true);
 }
 
@@ -32,7 +32,7 @@ const assert = require('assert');
   }));
 
   read.destroy(expected);
-  assert.strictEqual(read.readableErrored, expected);
+  assert.strictEqual(read.errored, expected);
   assert.strictEqual(read.destroyed, true);
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1242,7 +1242,7 @@ ObjectDefineProperties(Readable.prototype, {`
`1242`	`1242`	`}`
`1243`	`1243`	`},`
`1244`	`1244`
`1245`		`- readableErrored: {`
	`1245`	`+ errored: {`
`1246`	`1246`	`enumerable: false,`
`1247`	`1247`	`get() {`
`1248`	`1248`	`return this._readableState ? this._readableState.errored : null;`
Original file line number	Diff line number	Diff line change
`@@ -858,7 +858,7 @@ ObjectDefineProperties(Writable.prototype, {`
`858`	`858`	`}`
`859`	`859`	`},`
`860`	`860`
`861`		`- writableErrored: {`
	`861`	`+ errored: {`
`862`	`862`	`enumerable: false,`
`863`	`863`	`get() {`
`864`	`864`	`return this._writableState ? this._writableState.errored : null;`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ const assert = require('assert');`
`13`	`13`	`read.on('close', common.mustCall());`
`14`	`14`
`15`	`15`	`read.destroy();`
`16`		`- assert.strictEqual(read.readableErrored, null);`
	`16`	`+ assert.strictEqual(read.errored, null);`
`17`	`17`	`assert.strictEqual(read.destroyed, true);`
`18`	`18`	`}`
`19`	`19`
`@@ -32,7 +32,7 @@ const assert = require('assert');`
`32`	`32`	`}));`
`33`	`33`
`34`	`34`	`read.destroy(expected);`
`35`		`- assert.strictEqual(read.readableErrored, expected);`
	`35`	`+ assert.strictEqual(read.errored, expected);`
`36`	`36`	`assert.strictEqual(read.destroyed, true);`
`37`	`37`	`}`
`38`	`38`