Skip to content

Commit d27cc1b

Browse files
trivikrTrott
authored andcommitted
doc,http: add extends for derived classes
Also removed redundant statments as extends is self-explanatory. PR-URL: #29255 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 3f71489 commit d27cc1b

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

doc/api/http.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,8 @@ agent. Do not modify.
295295
added: v0.1.17
296296
-->
297297

298+
* Extends: {Stream}
299+
298300
This object is created internally and returned from [`http.request()`][]. It
299301
represents an _in-progress_ request whose header has already been queued. The
300302
header is still mutable using the [`setHeader(name, value)`][],
@@ -325,9 +327,6 @@ Unlike the `request` object, if the response closes prematurely, the
325327
Node.js does not check whether Content-Length and the length of the
326328
body which has been transmitted are equal or not.
327329

328-
The request inherits from [Stream][], and additionally implements the
329-
following:
330-
331330
### Event: 'abort'
332331
<!-- YAML
333332
added: v1.4.1
@@ -822,8 +821,7 @@ nothing and waits for more input.
822821
added: v0.1.17
823822
-->
824823

825-
This class inherits from [`net.Server`][] and has the following additional
826-
events:
824+
* Extends: {net.Server}
827825

828826
### Event: 'checkContinue'
829827
<!-- YAML
@@ -1115,12 +1113,11 @@ affects new connections to the server, not any existing connections.
11151113
added: v0.1.17
11161114
-->
11171115

1116+
* Extends: {Stream}
1117+
11181118
This object is created internally by an HTTP server — not by the user. It is
11191119
passed as the second parameter to the [`'request'`][] event.
11201120

1121-
The response inherits from [Stream][], and additionally implements the
1122-
following:
1123-
11241121
### Event: 'close'
11251122
<!-- YAML
11261123
added: v0.6.7
@@ -1616,14 +1613,13 @@ the request body should be sent.
16161613
added: v0.1.17
16171614
-->
16181615

1616+
* Extends: {stream.Readable}
1617+
16191618
An `IncomingMessage` object is created by [`http.Server`][] or
16201619
[`http.ClientRequest`][] and passed as the first argument to the [`'request'`][]
16211620
and [`'response'`][] event respectively. It may be used to access response
16221621
status, headers and data.
16231622

1624-
It implements the [Readable Stream][] interface, as well as the
1625-
following additional events, methods, and properties.
1626-
16271623
### Event: 'aborted'
16281624
<!-- YAML
16291625
added: v0.3.8
@@ -2280,6 +2276,4 @@ not abort the request or do anything besides add a `'timeout'` event.
22802276
[`socket.setTimeout()`]: net.html#net_socket_settimeout_timeout_callback
22812277
[`socket.unref()`]: net.html#net_socket_unref
22822278
[`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost
2283-
[Readable Stream]: stream.html#stream_class_stream_readable
2284-
[Stream]: stream.html#stream_stream
22852279
[`HPE_HEADER_OVERFLOW`]: errors.html#errors_hpe_header_overflow

0 commit comments

Comments
 (0)