summaryrefslogtreecommitdiff
path: root/doc/api/http2.md
diff options
context:
space:
mode:
authorMaleDong <maledong_github@outlook.com>2018-08-14 08:57:24 +0800
committerRich Trott <rtrott@gmail.com>2018-08-15 19:59:31 -0700
commit16accff90f25543b31c4e3dc0e71c5766795dc18 (patch)
treed3287c5537bf41bb262800ea99e24dc5bea32365 /doc/api/http2.md
parent97c1fa3d3b98bf1b28cf3362e197ae91093cf68f (diff)
downloadandroid-node-v8-16accff90f25543b31c4e3dc0e71c5766795dc18.tar.gz
android-node-v8-16accff90f25543b31c4e3dc0e71c5766795dc18.tar.bz2
android-node-v8-16accff90f25543b31c4e3dc0e71c5766795dc18.zip
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: https://github.com/nodejs/node/issues/14146. PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc/api/http2.md')
-rw-r--r--doc/api/http2.md6
1 files changed, 2 insertions, 4 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md
index 34a53e33b7..78894c3aea 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -2711,8 +2711,8 @@ added: v8.4.0
This object is created internally by an HTTP server — not by the user. It is
passed as the second parameter to the [`'request'`][] event.
-The response implements, but does not inherit from, the [Writable Stream][]
-interface. This is an [`EventEmitter`][] with the following events:
+The response inherits from [Stream][], and additionally implements the
+following:
#### Event: 'close'
<!-- YAML
@@ -3231,13 +3231,11 @@ following additional properties:
[Readable Stream]: stream.html#stream_class_stream_readable
[RFC 7838]: https://tools.ietf.org/html/rfc7838
[Using `options.selectPadding()`]: #http2_using_options_selectpadding
-[Writable Stream]: stream.html#stream_writable_streams
[`'checkContinue'`]: #http2_event_checkcontinue
[`'request'`]: #http2_event_request
[`'unknownProtocol'`]: #http2_event_unknownprotocol
[`ClientHttp2Stream`]: #http2_class_clienthttp2stream
[`Duplex`]: stream.html#stream_class_stream_duplex
-[`EventEmitter`]: events.html#events_class_eventemitter
[`Http2ServerRequest`]: #http2_class_http2_http2serverrequest
[`Http2Session` and Sockets]: #http2_http2session_and_sockets
[`Http2Stream`]: #http2_class_http2stream