doc: add documentation for the 'timeout' event

lpinca · jasnell · commit 7fa2bee5e779 · 2017-09-20T07:50:37.000-07:00
Adds the `'timeout'` event to the `http.ClientRequest` documentation. PR-URL: #15443 Fixes: #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>
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -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
@@ -1909,6 +1919,7 @@ const req = http.request(options, (res) => {
 [`net.Socket`]: net.html#net_class_net_socket
 [`net.createConnection()`]: net.html#net_net_createconnection_options_connectlistener
 [`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
