Skip to content

doc: document http agent options property #63351

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

Closed
MukundaKatta wants to merge 1 commit into from
+16 −0
Closed

doc: document http agent options property #63351

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
16 changes: 16 additions & 0 deletions doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,21 @@ options.agent = keepAliveAgent;
http.request(options, onResponseCallback);
```

### `agent.options`

<!-- YAML
added: v0.3.4
-->

* {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])`

<!-- YAML
Expand Down Expand Up @@ -4701,6 +4716,7 @@ const agent2 = new http.Agent({ proxyEnv: process.env });
[`http.Server`]: #class-httpserver
[`http.createServer()`]: #httpcreateserveroptions-requestlistener
[`http.get()`]: #httpgetoptions-callback
[`http.globalAgent.options`]: #agentoptions
[`http.globalAgent`]: #httpglobalagent
[`http.request()`]: #httprequestoptions-callback
[`http.setGlobalProxyFromEnv()`]: #httpsetglobalproxyfromenvproxyenv
Expand Down
Loading