More polish.

Author: rkistner

.circleci/config.yml

@@ -1,35 +1,42 @@
 version: 2
 jobs:
-  build:
+  build_8:
     docker:
-      - image: circleci/node:8.11.4
+      - image: circleci/node:8.17.0
     steps:
       - checkout
       - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
-      - restore_cache:
-          keys:
-            - modules-{{ checksum "yarn.lock" }}
-      - run: yarn install --check-files --frozen-lockfile
-      - save_cache:
-          key: modules-{{ checksum "yarn.lock" }}
-          paths:
-            - node_modules
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
       - run: yarn run build
       - run: yarn run test
+
+  build_10:
+    docker:
+      - image: circleci/node:10.18.1
+    steps:
+      - checkout
+      - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
+      - run: yarn run build
+      - run: yarn run test
+
+  build_12:
+    docker:
+      - image: circleci/node:12.14.1
+    steps:
+      - checkout
+      - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
+      - run: yarn run build
+      - run: yarn run test
+
   publish:
     docker:
-      - image: circleci/node:8.11.4
+      - image: circleci/node:12.14.1
     steps:
       - checkout
       - run: echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
-      - restore_cache:
-          keys:
-            - modules-{{ checksum "yarn.lock" }}
-      - run: yarn install --check-files --frozen-lockfile
-      - save_cache:
-          key: modules-{{ checksum "yarn.lock" }}
-          paths:
-            - node_modules
+      - run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
       - run: yarn run build
       - run: ./node_modules/.bin/journey-deploy execute
 

README.md

@@ -9,33 +9,44 @@ but adapted to expose raw Sockets, instead of just http/https requests.
 
     yarn add @journeyapps/https-proxy-socket
 
-## Usage
+## Usage - node-fetch
 
+    const { HttpsProxySocket } = require('@journeyapps/https-proxy-socket');
+    const fetch = require('node-fetch');
+
+    // Proxy connection options
+    const proxy = new HttpsProxySocket('https://my-proxy.test', {
+      // Additional options for the proxy may be set here, for example:
+      auth: 'myuser:mypassword' // Basic auth
+    });
+
+    const agent = proxy.agent({
+      // Additional TLS options for the host may be set here, for example:
+      // rejectUnauthorized: false
+    });
+
+    const response = await fetch('https://myhost.test', { agent: agent });
+
+## Usage - Direct socket
 
     const { HttpsProxySocket } = require('@journeyapps/https-proxy-socket');
-    const proxy = new HttpsProxySocket({
-      // Connection options
-      host: 'my-proxy.test',
-      port: 443
-    }, {
+    const proxy = new HttpsProxySocket('https://my-proxy.test', {
         auth: 'myuser:mypassword' // Optional: proxy basic auth
     });
 
     const socket = await proxy.connect({host: 'myhost.test', port: 1234});
 
-## Usage with mssql
-
+## Usage - mssql
 
     const sql = require('mssql')
-    const { useProxy } = require('@journeyapps/https-proxy-socket/lib/TediousPatch');
+    const { HttpsProxySocket, useProxyForTedious } = require('@journeyapps/https-proxy-socket');
 
-    const { HttpsProxySocket } = require('./lib/HttpsProxySocket');
     const proxy = new HttpsProxySocket({
       // Same as above
     });
 
     // Register the proxy globally for tedious/mssql
-    useProxy(proxy);
+    useProxyForTedious(proxy);
 
     async function run() {
       // Connect using the proxy

src/HttpsProxySocket.ts

@@ -2,6 +2,7 @@
 
 import * as tls from 'tls';
 import * as url from 'url';
+import { proxyAgent } from './proxyAgent';
 
 const debug = require('debug')('https-proxy');
 
@@ -69,6 +70,15 @@ export class HttpsProxySocket {
     });
   }
 
+  /**
+   * Construct an agent for http(s) requests.
+   *
+   * @param options - to set additional TLS options for https requests, e.g. rejectUnauthorized
+   */
+  agent(options?: tls.ConnectionOptions) {
+    return proxyAgent(this, options);
+  }
+
   private _connect(opts: ConnectionOptions, cb: (error: any, socket: tls.TLSSocket) => void) {
     const proxy = this.proxy;
 

src/index.ts

@@ -1,3 +1,2 @@
 export * from './HttpsProxySocket';
 export * from './tediousPatch';
-export * from './agent';

src/agent.spec.ts src/proxyAgent.spec.tssrc/agent.spec.ts renamed to src/proxyAgent.spec.ts

@@ -6,7 +6,7 @@ import * as https from 'https';
 import * as assert from 'assert';
 
 import { HttpsProxySocket, HttpsProxyConfig } from './HttpsProxySocket';
-import { agent as proxyAgent } from './agent';
+import { proxyAgent } from './proxyAgent';
 import { ConnectionOptions } from 'tls';
 import { AddressInfo } from 'net';
 

src/agent.ts src/proxyAgent.tssrc/agent.ts renamed to src/proxyAgent.ts

@@ -8,7 +8,7 @@ import * as tls from 'tls';
  * @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) {
+export function proxyAgent(proxy: HttpsProxySocket, options?: tls.ConnectionOptions) {
   return agentBase(async (req, opts: any) => {
     const socket = await proxy.connect(opts);