Skip to content

Commit 8a93b63

Browse files
trivikrBridgeAR
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 <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 8599052 commit 8a93b63

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
@@ -819,8 +818,7 @@ nothing and waits for more input.
819818
added: v0.1.17
820819
-->
821820

822-
This class inherits from [`net.Server`][] and has the following additional
823-
events:
821+
* Extends: {net.Server}
824822

825823
### Event: 'checkContinue'
826824
<!-- YAML
@@ -1110,12 +1108,11 @@ affects new connections to the server, not any existing connections.
11101108
added: v0.1.17
11111109
-->
11121110

1111+
* Extends: {Stream}
1112+
11131113
This object is created internally by an HTTP server — not by the user. It is
11141114
passed as the second parameter to the [`'request'`][] event.
11151115

1116-
The response inherits from [Stream][], and additionally implements the
1117-
following:
1118-
11191116
### Event: 'close'
11201117
<!-- YAML
11211118
added: v0.6.7
@@ -1608,14 +1605,13 @@ the request body should be sent.
16081605
added: v0.1.17
16091606
-->
16101607

1608+
* Extends: {stream.Readable}
1609+
16111610
An `IncomingMessage` object is created by [`http.Server`][] or
16121611
[`http.ClientRequest`][] and passed as the first argument to the [`'request'`][]
16131612
and [`'response'`][] event respectively. It may be used to access response
16141613
status, headers and data.
16151614

1616-
It implements the [Readable Stream][] interface, as well as the
1617-
following additional events, methods, and properties.
1618-
16191615
### Event: 'aborted'
16201616
<!-- YAML
16211617
added: v0.3.8
@@ -2273,6 +2269,4 @@ not abort the request or do anything besides add a `'timeout'` event.
22732269
[`socket.setTimeout()`]: net.html#net_socket_settimeout_timeout_callback
22742270
[`socket.unref()`]: net.html#net_socket_unref
22752271
[`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost
2276-
[Readable Stream]: stream.html#stream_class_stream_readable
2277-
[Stream]: stream.html#stream_stream
22782272
[`HPE_HEADER_OVERFLOW`]: errors.html#errors_hpe_header_overflow

0 commit comments

Comments
 (0)