doc: explain ClientRequest#setTimeout time unit

State a time unit for the timeout parameter in ClientRequest#setTimeout PR-URL: #4458 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Jan 19, 2016 · bf56d50 · bf56d50
1 parent d927c51
commit bf56d50
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/doc/api/http.markdown b/doc/api/http.markdown
@@ -375,6 +375,9 @@ Once a socket is assigned to this request and is connected
 Once a socket is assigned to this request and is connected
 [`socket.setTimeout()`][] will be called.
 
+* `timeout` {Number} Milliseconds before a request is considered to be timed out.
+* `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.
+
 ### request.write(chunk[, encoding][, callback])
 
 Sends a chunk of the body.  By calling this method