1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc,http: add extends for derived classes

Browse Source 
Also removed redundant statments as extends is self-explanatory.

PR-URL: https://github.com/nodejs/node/pull/29255
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Trivikram Kamat 2019-08-21 13:11:16 -07:00 committed by Rich Trott
parent 3f714895ca
commit d27cc1b6bb
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/api/http.md
View File

@ -295,6 +295,8 @@ agent. Do not modify.
added: v0.1.17
-->
* Extends: {Stream}
This object is created internally and returned from [`http.request()`][]. It
represents an _in-progress_ request whose header has already been queued. The
header is still mutable using the [`setHeader(name, value)`][],
@ -325,9 +327,6 @@ Unlike the `request` object, if the response closes prematurely, the
Node.js does not check whether Content-Length and the length of the
body which has been transmitted are equal or not.
The request inherits from [Stream][], and additionally implements the
following:
### Event: 'abort'
<!-- YAML
added: v1.4.1
@ -822,8 +821,7 @@ nothing and waits for more input.
added: v0.1.17
-->
This class inherits from [`net.Server`][] and has the following additional
events:
* Extends: {net.Server}
### Event: 'checkContinue'
<!-- YAML
@ -1115,12 +1113,11 @@ affects new connections to the server, not any existing connections.
added: v0.1.17
-->
* Extends: {Stream}
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 inherits from [Stream][], and additionally implements the
following:
### Event: 'close'
<!-- YAML
added: v0.6.7
@ -1616,14 +1613,13 @@ the request body should be sent.
added: v0.1.17
-->
* Extends: {stream.Readable}
An `IncomingMessage` object is created by [`http.Server`][] or
[`http.ClientRequest`][] and passed as the first argument to the [`'request'`][]
and [`'response'`][] event respectively. It may be used to access response
status, headers and data.
It implements the [Readable Stream][] interface, as well as the
following additional events, methods, and properties.
### Event: 'aborted'
<!-- YAML
added: v0.3.8
@ -2280,6 +2276,4 @@ not abort the request or do anything besides add a `'timeout'` event.
[`socket.setTimeout()`]: net.html#net_socket_settimeout_timeout_callback
[`socket.unref()`]: net.html#net_socket_unref
[`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost
[Readable Stream]: stream.html#stream_class_stream_readable
[Stream]: stream.html#stream_stream
[`HPE_HEADER_OVERFLOW`]: errors.html#errors_hpe_header_overflow