Skip to content

Commit

Permalink
doc: explain ClientRequest#setTimeout time unit
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
bripkens authored and Myles Borins committed Jan 19, 2016
1 parent d927c51 commit bf56d50
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/http.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bf56d50

Please sign in to comment.