Class HttpProxyOptions

Proxy options for HTTP clients.

Hierarchy

Constructors

constructor

Properties

tls_opts? connection_type? host_name port auth_method auth_username? auth_password?

Constructors

constructor

  • Parameters

    • host_name: string

      Name of the proxy server to connect through

    • port: number

      Port number of the proxy server to connect through

    • auth_method: HttpProxyAuthenticationType = HttpProxyAuthenticationType.None

      Type of proxy authentication to use. Default is None

    • Optional auth_username: string

      Username to use when auth_type is Basic

    • Optional auth_password: string

      Password to use when auth_type is Basic

    • Optional tls_opts: TlsConnectionOptions

      Optional TLS connection options for the connection to the proxy host. Must be distinct from the TlsConnectionOptions provided to the HTTP connection

    • Optional connection_type: HttpProxyConnectionType

      Optional Type of connection to make. If not specified, Legacy will be used.

    Returns HttpProxyOptions

Properties

Optional tls_opts

tls_opts?: TlsConnectionOptions

Optional TLS connection options for the connection to the proxy host. Must be distinct from the TlsConnectionOptions provided to the HTTP connection

Optional connection_type

connection_type?: HttpProxyConnectionType

Optional Type of connection to make. If not specified, Legacy will be used.

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc