Updated to use promise so async/await can be used.

Author: beaudurrant

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2.1
 jobs:
   build:
     docker:
-      - image: circleci/node:7.10
+      - image: circleci/node:12.19
 
     working_directory: ~/node-port-scanner
 

README.md

@@ -17,37 +17,56 @@ npm install node-port-scanner
 ## Usage
 
 ```javascript
-const { nodePortScanner } = require('node-port-scanner');
-
-// scan for open common ports
-nodePortScanner('127.0.0.1', [21, 22, 25, 80, 110, 123, 443], 'open', function (results) {
-  console.log(results);
-});
-
-// scan for open common ports
-nodePortScanner('github.com', [21, 22, 25, 80, 110, 123, 443], 'open', function (results) {
-  console.log(results);
-});
-
-// scan for closed common ports
-nodePortScanner('127.0.0.1', [21, 22, 25, 80, 110, 123, 443], 'closed', function (results) {
-  console.log(results);
-});
-
-// scan for closed common ports
-nodePortScanner('github.com', [21, 22, 25, 80, 110, 123, 443], 'closed', function (results) {
-  console.log(results);
-});
-
-// scan for all open ports - not recommended on remote hosts
-nodePortScanner('127.0.0.1', [], 'open', function (results) {
-  console.log(results);
-});
-
-// scan for all closed ports - not recommended on remote hosts
-nodePortScanner('127.0.0.1', [], 'closed', function (results) {
-  console.log(results);
-});
+const nodePortScanner = require('node-port-scanner');
+
+// scan for open local common ports
+nodePortScanner('127.0.0.1', [21, 22, 23, 25, 80, 110, 123, 443], 'open')
+  .then(results => {  
+    console.log(results);
+  })
+  .catch(error => {
+    console.log('Error: ' + error);
+  });
+
+// scan for open remote common ports
+nodePortScanner('github.com', [21, 22, 23, 25, 80, 110, 123, 443], 'open')
+  .then(results => {  
+    console.log(results);
+  })
+  .catch(error => {
+    console.log('Error: ' + error);
+  });
+
+//scan for closed local common ports
+nodePortScanner('127.0.0.1', [21, 22, 23, 25, 80, 110, 123, 443], 'closed')
+  .then(results => {  
+    console.log(results);
+  })
+  .catch(error => {
+    console.log('Error: ' + error);
+  });
+
+// scan for closed remote common ports
+nodePortScanner('github.com', [21, 22, 23, 25, 80, 110, 123, 443], 'closed')
+  .then(results => {  
+    console.log(results);
+  })
+  .catch(error => {
+    console.log('Error: ' + error);
+  });
+
+
+// make calls in parallel - remote port checking not recommended
+async function checkLocalPorts () {
+  
+  const openPorts = nodePortScanner('127.0.0.1', [], 'open');
+  const closedPorts = nodePortScanner('127.0.0.1', [], 'closed');
+  
+  console.log(await openPorts);
+  console.log(await closedPorts);
+  
+}
+checkLocalPorts();
 ```
 
 ## Test

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-port-scanner",
-  "version": "1.0.4",
+  "version": "2.0.0",
   "description": "Simple JavaScript port scanner for open/closed ports",
   "keywords": [
     "portscanner",

src/node-port-scanner.js

@@ -2,94 +2,94 @@
 const net = require('net');
 
 // scan range of ports for status (open|closed)
-const nodePortScanner = (host, ports, status, callback) => {
+module.exports = nodePortScanner = (host, ports, status) => {
 
-  // all ports that exist
-  const allPorts = Array.from({length: 65535}, (_, i) => i + 1);
-
-  // connect to a single port and get the status
-  const connectToPort = (host, port, callback) => {
-    
-    // error checking args
-    if (!Number.isInteger(port)) throw new Error('port must be an integer');
-    if (port < 1 || port > 65535) throw new Error('port must be in range [1-65535]');
-    
-    let socket = new net.Socket();
-    // increase this if y'all on dial up
-    let timeout = 200;
-    
-    // new properties & events for port scanner
-    socket._scan = {};
-    socket._scan.status = 'initialized';
-    socket._scan.host = host;
-    socket._scan.port = port;
-    socket._scan._events = { complete : callback };
-    
-    // events for socket
-    socket.on('connect', function () {
-      this._scan.status = 'connect';
-      socket.destroy();
-    });
-    socket.on('timeout', function () {
-      this._scan.status = 'timeout';
-      socket.destroy();
-    });
-    socket.on('error', function (exception) {
-      this._scan.status = 'error';
-      socket.destroy();
-    });
-    socket.on('close', function (exception) {
-      this._scan._events.complete(this._scan);
-    });
+  return new Promise((resolve, reject) => {
 
-    socket.setTimeout(timeout);
-    socket.connect(port, host);
-    
-  };
-
-  // recursive function to check all port status one after the other is complete
-  const connectToPorts = (host, ports, status, scanResults, callback) => {
-    
-    let port = ports.shift();
-    
-    connectToPort(host, port, function (result) {
+    // all ports that exist
+    const allPorts = Array.from({length: 65535}, (_, i) => i + 1);
+  
+    // connect to a single port and get the status
+    const connectToPort = (host, port, callback) => {
 
-      // add to our results based on the status of the result and scan
-      if ((result.status == 'connect' && status == 'open') ||
-          (result.status != 'connect' && status == 'closed')) {
-        scanResults.ports.push(result.port);
-      }
+      // error checking args
+      if (!Number.isInteger(port)) reject('port must be an integer');
+      if (port < 1 || port > 65535) reject('port must be in range [1-65535]');
 
-      // recursivly go through all the ports
-      if (ports.length) {
-        connectToPorts(host, ports, status, scanResults, callback);
-      }
-      // when ports are done then complete callback from the scan
-      else {
-        callback(scanResults);
-      }
+      let socket = new net.Socket();
+      // increase this if y'all on dial up
+      let timeout = 200;
 
-    });
-    
-  };
-  
-  // error checking args
-  if (host == undefined || !host) throw new Error('host is required');
-  if (ports == undefined || !ports) throw new Error('ports is required');
-  if (!Array.isArray(ports)) throw new Error('ports must be an array');
-  if (status == undefined || !status) throw new Error('status is required');
-  if (status.toLowerCase() != 'open' && status.toLowerCase() != 'closed') throw new Error('status must be open or closed');
-  if (callback == undefined || !callback || typeof callback != 'function') throw new Error('callback is required');
+      // new properties & events for port scanner
+      socket._scan = {};
+      socket._scan.status = 'initialized';
+      socket._scan.host = host;
+      socket._scan.port = port;
+      socket._scan._events = { complete : callback };
+      
+      // events for socket
+      socket.on('connect', function () {
+        this._scan.status = 'connect';
+        socket.destroy();
+      });
+      socket.on('timeout', function () {
+        this._scan.status = 'timeout';
+        socket.destroy();
+      });
+      socket.on('error', function (exception) {
+        this._scan.status = 'error';
+        socket.destroy();
+      });
+      socket.on('close', function (exception) {
+        this._scan._events.complete(this._scan);
+      });
+      
+      socket.setTimeout(timeout);
+      socket.connect(port, host);
+      
+    };
 
-  // scan results will be and array of port numbers matching status
-  let scanResults = { host : host, status : status, ports : [] };
+    // recursive function to check all port status one after the other is complete
+    const connectToPorts = (host, ports, status, scanResults) => {
+      
+      let port = ports.shift();
+      
+      connectToPort(host, port, function (result) {
+        
+        // add to our results based on the status of the result and scan
+        if ((result.status == 'connect' && status == 'open') ||
+            (result.status != 'connect' && status == 'closed')) {
+          scanResults.ports.push(result.port);
+        }
+        
+        // recursivly go through all the ports
+        if (ports.length) {
+          connectToPorts(host, ports, status, scanResults);
+        }
+        // when ports are done resolve the promise
+        else {
+          resolve(scanResults);
+        }
+        
+      });
+      
+    };
+    
+    // error checking args
+    if (host == undefined || !host) reject('host is required');
+    if (ports == undefined || !ports) reject('ports is required');
+    if (!Array.isArray(ports)) reject('ports must be an array');
+    if (status == undefined || !status) reject('status is required');
+    if (status.toLowerCase() != 'open' && status.toLowerCase() != 'closed') reject('status must be open or closed');
 
-  // no ports = all ports
-  if (!ports.length) ports = allPorts;
+    // scan results will be and array of port numbers matching status
+    let scanResults = { host : host, status : status, ports : [] };
 
-  connectToPorts(host, ports, status, scanResults, callback);
+    // no ports = all ports
+    if (!ports.length) ports = allPorts;
+    
+    connectToPorts(host, ports, status, scanResults);
+  
+  });
 
 };
-
-// encapsulate methods
-module.exports = { nodePortScanner : nodePortScanner };