doc: Add maxTotalSockets option to agent constructor

rickyes · addaleax · commit 1a8669d6ec3c · 2020-09-29T00:01:12.000+02:00
PR-URL: #34013 Backport-PR-URL: #35396 Refs: #33617 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #33617 Fixes: #31942
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -112,6 +112,10 @@ http.get({
 ### `new Agent([options])`
 <!-- YAML
 added: v0.3.4
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/33617
+    description: Add `maxTotalSockets` option to agent constructor.
 -->
 
 * `options` {Object} Set of configurable options to set on the agent.
@@ -131,6 +135,10 @@ added: v0.3.4
   * `maxSockets` {number} Maximum number of sockets to allow per
     host. Each request will use a new socket until the maximum is reached.
     **Default:** `Infinity`.
+  * `maxTotalSockets` {number} Maximum number of sockets allowed for
+    all hosts in total. Each request will use a new socket
+    until the maximum is reached.
+    **Default:** `Infinity`.
   * `maxFreeSockets` {number} Maximum number of sockets to leave open
     in a free state. Only relevant if `keepAlive` is set to `true`.
     **Default:** `256`.
