You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the following example provided for the https.request method, the request config object is passed both to the top level https request object, and to the agent property of said object.
This seems to either be a typo, or unclear. I would expect to see the following:
"key" and "cert" should be provided to the agent object only, and should not appear at the top level of the options object.
The properties that comprise the URL object ("hostname", "port", "path" and "method") should not be provided to the agent object.
netanel-haber
changed the title
doc: Options passed to https request object and agent property
doc: Options passed needlessly to https request object and agent prop
Sep 26, 2020
@netanel-haber I think this was done for simplicity to avoid creating two options objects. Feel free to open a PR if you think that using two options objects clarifies the example. I personally don't mind.
📗 API Reference Docs Problem
Location
Affected URL(s):
Description
In the following example provided for the https.request method, the request config object is passed both to the top level https request object, and to the agent property of said object.
This seems to either be a typo, or unclear. I would expect to see the following:
I think this would avoid confusion.
The text was updated successfully, but these errors were encountered: