From 6e2ffc0de5042c5a89647808de6d0aa16331ae50 Mon Sep 17 00:00:00 2001 From: mukunda katta Date: Fri, 15 May 2026 13:24:38 -0700 Subject: [PATCH] doc: document http agent options property --- doc/api/http.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/api/http.md b/doc/api/http.md index a916337287e109..f21d05ad564e2d 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -230,6 +230,21 @@ options.agent = keepAliveAgent; http.request(options, onResponseCallback); ``` +### `agent.options` + + + +* {Object} + +The options used by the agent when creating new connections. This is a shallow +copy of the `options` argument passed to the [`Agent`][] constructor, with +agent defaults and normalizations applied. + +For example, [`http.globalAgent.options`][] can be used as the base options +when creating another [`Agent`][] instance with additional custom settings. + ### `agent.createConnection(options[, callback])`