Skip to content

Commit

Permalink
doc: add hints to http.request() options
Browse files Browse the repository at this point in the history
PR-URL: #37745
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
  • Loading branch information
lpinca authored and targos committed May 1, 2021
1 parent b5c5bd1 commit 5f2da5a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/api/http.md
Expand Up @@ -2377,6 +2377,7 @@ changes:
`hostname`. Valid values are `4` or `6`. When unspecified, both IP v4 and
v6 will be used.
* `headers` {Object} An object containing request headers.
* `hints` {number} Optional [`dns.lookup()` hints][].
* `host` {string} A domain name or IP address of the server to issue the
request to. **Default:** `'localhost'`.
* `hostname` {string} Alias for `host`. To support [`url.parse()`][],
Expand Down Expand Up @@ -2687,6 +2688,7 @@ try {
[`agent.getName()`]: #http_agent_getname_options
[`destroy()`]: #http_agent_destroy
[`dns.lookup()`]: dns.md#dns_dns_lookup_hostname_options_callback
[`dns.lookup()` hints]: dns.md#dns_supported_getaddrinfo_flags
[`getHeader(name)`]: #http_request_getheader_name
[`http.Agent`]: #http_class_http_agent
[`http.ClientRequest`]: #http_class_http_clientrequest
Expand Down

0 comments on commit 5f2da5a

Please sign in to comment.