Commit 7972298
doc: clarify ServerResponse explanations
In short: `ServerResponse` acutally inherits from `OutgoingMessage`,
with a series of methods like those in `Stream.Writable`. So we cannot
use `implements`(this has made poeple feel puzzled because there are
still many methods we don't need or have), so `inherits from Stream` is
enough, due to some core reasons and performance told by mcollina from
the ref (See some latest discussions at Ref).
Ref: #14146.
PR-URL: #22305
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent d3ceaa1 commit 7972298
2 files changed
Lines changed: 6 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -313,8 +313,8 @@ the data is read it will consume memory that can eventually lead to a | |||
| 313 | 313 | Node.js does not check whether Content-Length and the length of the | |
| 314 | 314 | body which has been transmitted are equal or not. | |
| 315 | 315 | ||
| 316 | - The request implements the [Writable Stream][] interface. This is an | ||
| 317 | - [`EventEmitter`][] with the following events: | ||
| 316 | + The request inherits from [Stream][], and additionally implements the | ||
| 317 | + following: | ||
| 318 | 318 | ||
| 319 | 319 | ### Event: 'abort' | |
| 320 | 320 | <!-- YAML | |
@@ -1007,8 +1007,8 @@ added: v0.1.17 | |||
| 1007 | 1007 | This object is created internally by an HTTP server — not by the user. It is | |
| 1008 | 1008 | passed as the second parameter to the [`'request'`][] event. | |
| 1009 | 1009 | ||
| 1010 | - The response implements, but does not inherit from, the [Writable Stream][] | ||
| 1011 | - interface. This is an [`EventEmitter`][] with the following events: | ||
| 1010 | + The response inherits from [Stream][], and additionally implements the | ||
| 1011 | + following: | ||
| 1012 | 1012 | ||
| 1013 | 1013 | ### Event: 'close' | |
| 1014 | 1014 | <!-- YAML | |
@@ -2062,7 +2062,6 @@ not abort the request or do anything besides add a `'timeout'` event. | |||
| 2062 | 2062 | [`'upgrade'`]: #http_event_upgrade | |
| 2063 | 2063 | [`Agent`]: #http_class_http_agent | |
| 2064 | 2064 | [`Duplex`]: stream.html#stream_class_stream_duplex | |
| 2065 | - [`EventEmitter`]: events.html#events_class_eventemitter | ||
| 2066 | 2065 | [`TypeError`]: errors.html#errors_class_typeerror | |
| 2067 | 2066 | [`URL`]: url.html#url_the_whatwg_url_api | |
| 2068 | 2067 | [`agent.createConnection()`]: #http_agent_createconnection_options_callback | |
@@ -2105,4 +2104,3 @@ not abort the request or do anything besides add a `'timeout'` event. | |||
| 2105 | 2104 | [`socket.unref()`]: net.html#net_socket_unref | |
| 2106 | 2105 | [`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost | |
| 2107 | 2106 | [Readable Stream]: stream.html#stream_class_stream_readable | |
| 2108 | - [Writable Stream]: stream.html#stream_class_stream_writable | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2711,8 +2711,8 @@ added: v8.4.0 | |||
| 2711 | 2711 | This object is created internally by an HTTP server — not by the user. It is | |
| 2712 | 2712 | passed as the second parameter to the [`'request'`][] event. | |
| 2713 | 2713 | ||
| 2714 | - The response implements, but does not inherit from, the [Writable Stream][] | ||
| 2715 | - interface. This is an [`EventEmitter`][] with the following events: | ||
| 2714 | + The response inherits from [Stream][], and additionally implements the | ||
| 2715 | + following: | ||
| 2716 | 2716 | ||
| 2717 | 2717 | #### Event: 'close' | |
| 2718 | 2718 | <!-- YAML | |
@@ -3231,13 +3231,11 @@ following additional properties: | |||
| 3231 | 3231 | [Readable Stream]: stream.html#stream_class_stream_readable | |
| 3232 | 3232 | [RFC 7838]: https://tools.ietf.org/html/rfc7838 | |
| 3233 | 3233 | [Using `options.selectPadding()`]: #http2_using_options_selectpadding | |
| 3234 | - [Writable Stream]: stream.html#stream_writable_streams | ||
| 3235 | 3234 | [`'checkContinue'`]: #http2_event_checkcontinue | |
| 3236 | 3235 | [`'request'`]: #http2_event_request | |
| 3237 | 3236 | [`'unknownProtocol'`]: #http2_event_unknownprotocol | |
| 3238 | 3237 | [`ClientHttp2Stream`]: #http2_class_clienthttp2stream | |
| 3239 | 3238 | [`Duplex`]: stream.html#stream_class_stream_duplex | |
| 3240 | - [`EventEmitter`]: events.html#events_class_eventemitter | ||
| 3241 | 3239 | [`Http2ServerRequest`]: #http2_class_http2_http2serverrequest | |
| 3242 | 3240 | [`Http2Session` and Sockets]: #http2_http2session_and_sockets | |
| 3243 | 3241 | [`Http2Stream`]: #http2_class_http2stream | |
0 commit comments