From f504dbaba8aba2843f05a13be7d218f4d7469cbc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rub=C3=A9n=20Norte?= Date: Mon, 25 Jul 2016 00:07:44 +0200 Subject: [PATCH] Adding documentation for httpAgent and httpsAgent in README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e66db3c..253a811 100644 --- a/README.md +++ b/README.md @@ -289,7 +289,13 @@ These are the available config options for making requests. Only the `url` is re // `maxRedirects` defines the maximum number of redirects to follow in node.js. // If set to 0, no redirects will be followed. - maxRedirects: 5 // default + maxRedirects: 5, // default + + // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http + // and https requests, respectively, in node.js. This allows to configure options like + // `keepAlive` that are not enabled by default. + httpAgent: new http.Agent({ keepAlive: true }), + httpsAgent: new https.Agent({ keepAlive: true }) } ```