Skip to content

Commit c745b4d

Browse files
bripkensFishrock123
authored andcommitted
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]>
1 parent 40076bf commit c745b4d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/api/http.markdown

+3
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,9 @@ Once a socket is assigned to this request and is connected
375375
Once a socket is assigned to this request and is connected
376376
[`socket.setTimeout()`][] will be called.
377377

378+
* `timeout` {Number} Milliseconds before a request is considered to be timed out.
379+
* `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.
380+
378381
### request.write(chunk[, encoding][, callback])
379382

380383
Sends a chunk of the body. By calling this method

0 commit comments

Comments
 (0)