fix(trivial): docs cleanup

Author: shazron

README.md

@@ -144,18 +144,18 @@ This provides a wrapper for fetch that facilitates proxy auth authorization.
 **Kind**: global class  
 
 * [ProxyFetch](#ProxyFetch)
-    * [new ProxyFetch(authOptions)](#new_ProxyFetch_new)
+    * [new ProxyFetch(proxyAuthOptions)](#new_ProxyFetch_new)
     * [.fetch(resource, options)](#ProxyFetch+fetch) ⇒ <code>Promise.&lt;Response&gt;</code>
 
 <a name="new_ProxyFetch_new"></a>
 
-### new ProxyFetch(authOptions)
+### new ProxyFetch(proxyAuthOptions)
 Initialize this class with Proxy auth options
 
 
 | Param | Type | Description |
 | --- | --- | --- |
-| authOptions | [<code>ProxyAuthOptions</code>](#ProxyAuthOptions) | the auth options to connect with |
+| proxyAuthOptions | [<code>ProxyAuthOptions</code>](#ProxyAuthOptions) | the auth options to connect with |
 
 <a name="ProxyFetch+fetch"></a>
 
@@ -220,6 +220,8 @@ Proxy Auth Options
 | Name | Type | Description |
 | --- | --- | --- |
 | proxyUrl | <code>string</code> | the proxy's url |
+| [username] | <code>string</code> | the username for basic auth |
+| [password] | <code>string</code> | the password for basic auth |
 | rejectUnauthorized | <code>boolean</code> | set to false to not reject unauthorized server certs |
 
 ### Debug Logs

src/ProxyFetch.js

@@ -25,6 +25,7 @@ const { urlToHttpOptions } = require('./utils')
  *
  * See https://github.com/TooTallNate/proxy-agents/issues/89
  * An alternative is to use https://github.com/delvedor/hpagent
+ * @private
  */
 class PatchedHttpsProxyAgent extends HttpsProxyAgent {
   constructor (proxyUrl, opts) {
@@ -41,11 +42,11 @@ class PatchedHttpsProxyAgent extends HttpsProxyAgent {
  * @private
  *
  * @param {string} resourceUrl an endpoint url for proxyAgent selection
- * @param {object} authOptions an object which contains auth information
+ * @param {ProxyAuthOptions} proxyOptions an object which contains auth information
  * @returns {http.Agent} a http.Agent for basic auth proxy
  */
-function proxyAgent (resourceUrl, authOptions) {
-  const { proxyUrl, username, password, rejectUnauthorized = true } = authOptions
+function proxyAgent (resourceUrl, proxyAuthOptions) {
+  const { proxyUrl, username, password, rejectUnauthorized = true } = proxyAuthOptions
   const proxyOpts = urlToHttpOptions(proxyUrl)
 
   if (!proxyOpts.auth && username && password) {
@@ -70,6 +71,8 @@ function proxyAgent (resourceUrl, authOptions) {
  *
  * @typedef {object} ProxyAuthOptions
  * @property {string} proxyUrl - the proxy's url
+ * @property {string} [username] the username for basic auth
+ * @property {string} [password] the password for basic auth
  * @property {boolean} rejectUnauthorized - set to false to not reject unauthorized server certs
  */
 
@@ -80,11 +83,11 @@ class ProxyFetch {
   /**
    * Initialize this class with Proxy auth options
    *
-   * @param {ProxyAuthOptions} authOptions the auth options to connect with
+   * @param {ProxyAuthOptions} proxyAuthOptions the auth options to connect with
    */
-  constructor (authOptions = {}) {
-    logger.debug(`constructor - authOptions: ${JSON.stringify(authOptions)}`)
-    const { proxyUrl } = authOptions
+  constructor (proxyAuthOptions = {}) {
+    logger.debug(`constructor - authOptions: ${JSON.stringify(proxyAuthOptions)}`)
+    const { proxyUrl } = proxyAuthOptions
     const { auth } = urlToHttpOptions(proxyUrl)
 
     if (!proxyUrl) {
@@ -96,7 +99,7 @@ class ProxyFetch {
       logger.debug('constructor: username or password not set, proxy is anonymous.')
     }
 
-    this.authOptions = authOptions
+    this.authOptions = proxyAuthOptions
     return this
   }
 

types.d.ts

@@ -32,19 +32,23 @@ declare class HttpExponentialBackoff {
 /**
  * Proxy Auth Options
  * @property proxyUrl - the proxy's url
+ * @property [username] - the username for basic auth
+ * @property [password] - the password for basic auth
  * @property rejectUnauthorized - set to false to not reject unauthorized server certs
  */
 declare type ProxyAuthOptions = {
     proxyUrl: string;
+    username?: string;
+    password?: string;
     rejectUnauthorized: boolean;
 };
 
 /**
  * Initialize this class with Proxy auth options
- * @param authOptions - the auth options to connect with
+ * @param proxyAuthOptions - the auth options to connect with
  */
 declare class ProxyFetch {
-    constructor(authOptions: ProxyAuthOptions);
+    constructor(proxyAuthOptions: ProxyAuthOptions);
     /**
      * Fetch function, using the configured NTLM Auth options.
      * @param resource - the url or Request object to fetch from