Add/update docs.

Author: rkistner

src/HttpsProxyAgent.ts

@@ -5,7 +5,8 @@ import * as tls from 'tls';
 /**
  * Construct an agent for http(s) requests. Mostly for testing purposes.
  *
- * @param proxy
+ * @param proxy - the proxy to use
+ * @param options - to set additional TLS options for https requests, e.g. rejectUnauthorized
  */
 export function agent(proxy: HttpsProxySocket, options?: tls.ConnectionOptions) {
   return agentBase(async (req, opts: any) => {

src/HttpsProxySocket.ts

@@ -16,16 +16,21 @@ export interface ConnectionOptions {
 }
 
 /**
- * The `HttpsProxyAgent` implements an HTTP Agent subclass that connects to the
- * specified "HTTP(s) proxy server" in order to proxy HTTPS requests.
- *
- * @api public
+ * The HttpsProxySocket class allows creating Socket connections via an HTTPS proxy.
+ * HTTP proxies are not supported.
+ * For http(s) requests, use HttpsProxyAgent as a wrapper around this.
  */
-
 export class HttpsProxySocket {
   proxy: tls.ConnectionOptions;
   proxyConfig: HttpsProxyConfig;
 
+  /**
+   *
+   * @param opts - The connection options to the proxy. At least host and port are required.
+   *               Use {rejectUnauthorized: true} to ignore certificates for the proxy (not the endpoint).
+   * @param proxyConfig - { auth: 'username:password' } for basic auth.
+   *                      { headers: {key: 'value'} } for custom headers.
+   */
   constructor(opts: tls.ConnectionOptions | string, proxyConfig?: HttpsProxyConfig) {
     let sanitizedOptions;
     if (typeof opts == 'string') {
@@ -50,7 +55,7 @@ export class HttpsProxySocket {
   /**
    * Create a new Socket connection.
    *
-   * @param opts - hostname and port
+   * @param opts - host and port
    */
   connect(opts: ConnectionOptions): Promise<tls.TLSSocket> {
     return new Promise<tls.TLSSocket>((resolve, reject) => {