Class CommonHttpProxyOptions

Options used when connecting to an HTTP endpoint via a proxy

Hierarchy

CommonHttpProxyOptions
- HttpProxyOptions

Index

Constructors

Properties

host_name port auth_method auth_username? auth_password?

Constructors

constructor

new CommonHttpProxyOptions(host_name, port, auth_method?, auth_username?, auth_password?): CommonHttpProxyOptions
Parameters
- host_name: string
  
  endpoint of the proxy to use
- port: number
  
  port of proxy to use
- auth_method: HttpProxyAuthenticationType = HttpProxyAuthenticationType.None
  
  type of authentication to use with the proxy
- Optional auth_username: string
  
  (basic authentication only) proxy username
- Optional auth_password: string
  
  (basic authentication only) password associated with the username
Returns CommonHttpProxyOptions

Properties

host_name

host_name: string

endpoint of the proxy to use

port

port: number

port of proxy to use

auth_method

auth_method: HttpProxyAuthenticationType = HttpProxyAuthenticationType.None

type of authentication to use with the proxy

`Optional` auth_username

auth_username?: string

(basic authentication only) proxy username

`Optional` auth_password

auth_password?: string

(basic authentication only) password associated with the username

Generated using TypeDoc