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

doc: add documentation for the 'timeout' event

Browse Source 
Adds the `'timeout'` event to the `http.ClientRequest` documentation.

PR-URL: https://github.com/nodejs/node/pull/15443
Fixes: https://github.com/nodejs/node/issues/14856
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Luigi Pinca 2017-09-17 09:30:16 +02:00 committed by Ruben Bridgewater
parent 15879adf1d
commit 784cdad740
No known key found for this signature in database
GPG Key ID: F07496B3EB3C1762
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/http.md
View File

@ -427,6 +427,16 @@ added: v0.5.3
Emitted after a socket is assigned to this request.
### Event: 'timeout'
<!-- YAML
added: v0.7.8
-->
Emitted when the underlying socket times out from inactivity. This only notifies
that the socket has been idle. The request must be aborted manually.
See also: [`request.setTimeout()`][]
### Event: 'upgrade'
<!-- YAML
added: v0.1.94
@ -1966,6 +1976,7 @@ const req = http.request(options, (res) => {
[`net.createConnection()`]: net.html#net_net_createconnection_options_connectlistener
[`removeHeader(name)`]: #requestremoveheadername
[`request.end()`]: #http_request_end_data_encoding_callback
[`request.setTimeout()`]: #http_request_settimeout_timeout_callback
[`request.socket`]: #http_request_socket
[`request.socket.getPeerCertificate()`]: tls.html#tls_tlssocket_getpeercertificate_detailed
[`request.write(data, encoding)`]: #http_request_write_chunk_encoding_callback