From 7fa2bee5e779faec025837e78a6837bb32bd07fc Mon Sep 17 00:00:00 2001
From: Luigi Pinca <luigipinca@gmail.com>
Date: Sun, 17 Sep 2017 09:30:16 +0200
Subject: [PATCH] doc: add documentation for the 'timeout' event

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>
---
 doc/api/http.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/api/http.md b/doc/api/http.md
index e646e291ac724c..f7355e0fbe6630 100644
--- 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