Skip to content

doc: clarify agent.options is not part of public API #62921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rio767 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

doc: clarify agent.options is not part of public API #62921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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])`

Expand Down
Loading