http: return this from IncomingMessage#destroy()

cjihrig · addaleax · commit fb68487b8c0b · 2020-09-22T23:47:57.000+02:00
This commit updates IncomingMessage#destroy() to return `this` for consistency with other readable streams. PR-URL: #32789 Fixes: #32772 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>
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -1833,9 +1833,15 @@ const req = http.request({
 ### `message.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}
+* Returns: {this}
 
 Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`
 is provided, an `'error'` event is emitted on the socket and `error` is passed
diff --git a/lib/_http_incoming.js b/lib/_http_incoming.js
@@ -114,6 +114,7 @@ IncomingMessage.prototype._read = function _read(n) {
 IncomingMessage.prototype.destroy = function destroy(error) {
   if (this.socket)
     this.socket.destroy(error);
+  return this;
 };
 
 
diff --git a/test/parallel/test-http-incoming-message-destroy.js b/test/parallel/test-http-incoming-message-destroy.js
@@ -0,0 +1,10 @@
+'use strict';
+
+// Test that http.IncomingMessage,prototype.destroy() returns `this`.
+require('../common');
+
+const assert = require('assert');
+const http = require('http');
+const incomingMessage = new http.IncomingMessage();
+
+assert.strictEqual(incomingMessage.destroy(), incomingMessage);
