From bf56d509b9f258ff80190e0fec6c269ef7713c85 Mon Sep 17 00:00:00 2001 From: Ben Ripkens Date: Tue, 29 Dec 2015 00:10:21 +0100 Subject: [PATCH] doc: explain ClientRequest#setTimeout time unit State a time unit for the timeout parameter in ClientRequest#setTimeout PR-URL: https://github.com/nodejs/node/pull/4458 Reviewed-By: Stephen Belanger Reviewed-By: James M Snell --- doc/api/http.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/api/http.markdown b/doc/api/http.markdown index 6562a469a73bdb..f62b248f63d5fe 100644 --- 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