http: return this from ClientRequest#destroy()

This commit updates ClientRequest#destroy() to return `this` for consistency with other writable streams. PR-URL: #32789 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
nodejs · cjihrig · May 9, 2020 · Apr 11, 2020 · May 9, 2020 · May 9, 2020
commit cad76da198ff59e16d3439cbdb5793750c01f382
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -631,6 +631,11 @@ is finished.
 ### `request.destroy([error])`
 <!-- YAML
 added: v0.3.0
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/32789
+    description: The function returns `this` for consistency with other Readable
+                 streams.
 -->
 
 * `error` {Error} Optional, an error to emit with `'error'` event.

diff --git a/lib/_http_client.js b/lib/_http_client.js
@@ -349,7 +349,7 @@ ClientRequest.prototype.abort = function abort() {
 
 ClientRequest.prototype.destroy = function destroy(err) {
   if (this.destroyed) {
-    return;
+    return this;
   }
   this.destroyed = true;
 
@@ -365,6 +365,8 @@ ClientRequest.prototype.destroy = function destroy(err) {
   } else if (err) {
     this[kError] = err;
   }
+
+  return this;
 };
 
 function _destroy(req, socket, err) {

diff --git a/test/parallel/test-client-request-destroy.js b/test/parallel/test-client-request-destroy.js
@@ -0,0 +1,13 @@
+'use strict';
+
+// Test that http.ClientRequest,prototype.destroy() returns `this`.
+require('../common');
+
+const assert = require('assert');
+const http = require('http');
+const clientRequest = new http.ClientRequest({ createConnection: () => {} });
+
+assert.strictEqual(clientRequest.destroyed, false);
+assert.strictEqual(clientRequest.destroy(), clientRequest);
+assert.strictEqual(clientRequest.destroyed, true);
+assert.strictEqual(clientRequest.destroy(), clientRequest);