Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommonHttpProxyOptions

Options used when connecting to an HTTP endpoint via a proxy

Hierarchy

Index

Constructors

constructor

  • Parameters

    • host_name: string

      endpoint of the proxy to use

    • port: number

      port of proxy to use

    • Default value auth_method: HttpProxyAuthenticationType = HttpProxyAuthenticationType.None

      type of authentication to use with the proxy

    • Optional auth_username: undefined | string

      (basic authentication only) proxy username

    • Optional auth_password: undefined | string

      (basic authentication only) password associated with the username

    Returns CommonHttpProxyOptions

Properties

auth_method

type of authentication to use with the proxy

Optional auth_password

auth_password: undefined | string

(basic authentication only) password associated with the username

Optional auth_username

auth_username: undefined | string

(basic authentication only) proxy username

host_name

host_name: string

endpoint of the proxy to use

port

port: number

port of proxy to use

Generated using TypeDoc