GeezerVison is showing github.com — doc: add documentation for the 'timeout' event · nodejs/node@7fa2bee
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/api/http.md +11Lines changed: 11 additions & 0 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -427,6 +427,16 @@ added: v0.5.3 |
427 | 427 |
|
428 | 428 | Emitted after a socket is assigned to this request. |
429 | 429 |
|
| 430 | +### Event: 'timeout' |
| 431 | +<!-- YAML |
| 432 | +added: v0.7.8 |
| 433 | +--> |
| 434 | + |
| 435 | +Emitted when the underlying socket times out from inactivity. This only notifies |
| 436 | +that the socket has been idle. The request must be aborted manually. |
| 437 | + |
| 438 | +See also: [`request.setTimeout()`][] |
| 439 | + |
430 | 440 | ### Event: 'upgrade' |
431 | 441 | <!-- YAML |
432 | 442 | added: v0.1.94 |
@@ -1909,6 +1919,7 @@ const req = http.request(options, (res) => { |
1909 | 1919 | [`net.Socket`]: net.html#net_class_net_socket |
1910 | 1920 | [`net.createConnection()`]: net.html#net_net_createconnection_options_connectlistener |
1911 | 1921 | [`request.end()`]: #http_request_end_data_encoding_callback |
| 1922 | +[`request.setTimeout()`]: #http_request_settimeout_timeout_callback |
1912 | 1923 | [`request.socket`]: #http_request_socket |
1913 | 1924 | [`request.socket.getPeerCertificate()`]: tls.html#tls_tlssocket_getpeercertificate_detailed |
1914 | 1925 | [`request.write(data, encoding)`]: #http_request_write_chunk_encoding_callback |
|