Skip to content

Commit

Permalink
docs: document presence of tls options (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
gajus committed May 29, 2020
1 parent aa4b60c commit 72795c9
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,13 @@ Use [`roarr-cli`](https://github.com/gajus/roarr-cli) program to pretty-print th
* @property environmentVariableNamespace Defines namespace of `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables. (Default: `GLOBAL_AGENT_`)
* @property forceGlobalAgent Forces to use `global-agent` HTTP(S) agent even when request was explicitly constructed with another agent. (Default: `true`)
* @property socketConnectionTimeout Destroys socket if connection is not established within the timeout. (Default: `60000`)
* @property tls `tls.connect()` options.
*/
type ProxyAgentConfigurationInputType = {|
+environmentVariableNamespace?: string,
+forceGlobalAgent?: boolean,
+socketConnectionTimeout?: number,
+tls?: TlsConfigurationType,
|};

(configurationInput: ProxyAgentConfigurationInputType) => ProxyAgentConfigurationType;
Expand Down

0 comments on commit 72795c9

Please sign in to comment.