From eab22225900e14cf562435e5b81b1d7ea28bb45a Mon Sep 17 00:00:00 2001 From: rahulkotargasthi Date: Fri, 24 Apr 2026 09:31:56 +0530 Subject: [PATCH] doc: clarify agent.options is not part of public API Adds a note clarifying that agent.options is not part of the public API and should not be relied upon. --- doc/api/http.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/http.md b/doc/api/http.md index 8ac1ed166103b0..674bd7608f238a 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -231,6 +231,10 @@ const keepAliveAgent = new http.Agent({ keepAlive: true }); options.agent = keepAliveAgent; http.request(options, onResponseCallback); ``` +### `agent.options` + +> **Note:** The `options` property reflects the configuration used when creating the agent. However, this property is not part of the documented public API and should not be relied upon for application logic, as it may change without notice. + ### `agent.createConnection(options[, callback])`