.github/workflows/ci.yml

@@ -7,8 +7,23 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [0.12.x, 4.x, 6.x, 8.x, 10.x, 12.x, 14.x, 16.x, 18.x]
+        node-version: [0.12.x, 4.x, 6.x, 8.x, 10.x, 12.x, 14.x, 16.x, 18.x, 20.x, 22.x]
         os: [ubuntu-latest, macos-latest, windows-latest]
+        exclude:
+          - os: macos-latest
+            node-version: 0.12.x
+          - os: macos-latest
+            node-version: 4.x
+          - os: macos-latest
+            node-version: 6.x
+          - os: macos-latest
+            node-version: 8.x
+          - os: macos-latest
+            node-version: 10.x
+          - os: macos-latest
+            node-version: 12.x
+          - os: macos-latest
+            node-version: 14.x
 
     runs-on: ${{ matrix.os }}
 

lib/portfinder.d.ts

@@ -48,15 +48,34 @@ export let highestPort: number;
  */
 export function setHighestPort(port: number): void;
 
+/**
+ * Default path to begin any socket search from.
+ */
+ export let basePath: string;
+
+/**
+ * Set the base path to begin any socket search from.
+ */
+export function setBasePath(path: string): void;
+
 /**
  * Responds with a unbound port on the current machine.
  */
 export function getPort(callback: PortfinderCallback): void;
 export function getPort(options: PortFinderOptions, callback: PortfinderCallback): void;
 
-export function getPorts(count: number, options: PortFinderOptions, callback: (err: Error, ports: Array<number>) => void): void;
-
 /**
  * Responds a promise of an unbound port on the current machine.
  */
 export function getPortPromise(options?: PortFinderOptions): Promise<number>;
+
+/**
+ * Responds with an array of unbound ports on the current machine.
+ */
+export function getPorts(count: number, callback: (err: Error, ports: Array<number>) => void): void;
+export function getPorts(count: number, options: PortFinderOptions, callback: (err: Error, ports: Array<number>) => void): void;
+
+/**
+ * Responds a promise that resolves to an array of unbound ports on the current machine.
+ */
+export function getPortsPromise(count: number, options?: PortFinderOptions): Promise<Array<number>>;

lib/portfinder.js

@@ -39,8 +39,10 @@ internals.testPort = function(options, callback) {
     debugTestPort("done w/ testPort(): OK", options.host, "port", options.port);
 
     options.server.removeListener('error', onError);
-    options.server.close();
-    callback(null, options.port);
+    options.server.close(function () {
+      debugTestPort("done w/ testPort(): Server closed", options.host, "port", options.port);
+      callback(null, options.port);
+    });
   }
 
   function onError (err) {
@@ -115,6 +117,13 @@ exports.setHighestPort = function (port) {
 exports.basePath = '/tmp/portfinder'
 
 //
+// ### function setBasePath (path)
+// #### @path {String} The new base path
+//
+exports.setBasePath = function (path) {
+  exports.basePath = path;
+}
+
 // ### function getPort (options, callback)
 // #### @options {Object} Settings to use when finding the necessary port
 // #### @callback {function} Continuation to respond to when complete.
@@ -141,10 +150,8 @@ exports.getPort = function (options, callback) {
     }
   }
 
-  if (options.host) {
-    if (exports._defaultHosts.indexOf(options.host) !== -1) {
-      exports._defaultHosts.push(options.host)
-    }
+  if (options.host && exports._defaultHosts.indexOf(options.host) === -1) {
+    exports._defaultHosts.push(options.host)
   }
 
   var openPorts = [], currentHost;
@@ -266,6 +273,30 @@ exports.getPorts = function (count, options, callback) {
   }, callback);
 };
 
+//
+// ### function getPortPromise (options)
+// #### @count {Number} The number of ports to find
+// #### @options {Object} Settings to use when finding the necessary port
+// Responds with a promise that resolves to an array of unbound ports on the current machine.
+//
+exports.getPortsPromise = function (count, options) {
+  if (typeof Promise !== 'function') {
+    throw Error('Native promise support is not available in this version of node.' +
+      'Please install a polyfill and assign Promise to global.Promise before calling this method');
+  }
+  if (!options) {
+    options = {};
+  }
+  return new Promise(function(resolve, reject) {
+    exports.getPorts(count, options, function(err, ports) {
+      if (err) {
+        return reject(err);
+      }
+      resolve(ports);
+    });
+  });
+}
+
 //
 // ### function getSocket (options, callback)
 // #### @options {Object} Settings to use when finding the necessary port

package.json

@@ -1,8 +1,8 @@
 {
   "name": "portfinder",
   "description": "A simple tool to find an open port on the current machine",
-  "version": "1.0.32",
-  "author": "Charlie Robbins <charlie.robbins@gmail.com>",
+  "version": "1.0.33",
+  "author": "Charlie Robbins <charlie.robbins@gmail.com>, Erik Trom <erik.trom@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git@github.com:http-party/node-portfinder.git"

test/port-finder-multiple-test.js

@@ -59,4 +59,40 @@ vows.describe('portfinder').addBatch({
       }
     }
   }
+}).addBatch({
+  "When using portfinder module": {
+    "with no existing servers": {
+      topic: function () {
+        closeServers();
+        return null;
+      },
+      "the getPortPromises() method with an argument of 3": {
+        topic: function () {
+          var vow = this;
+
+          portfinder.getPortsPromise(3)
+            .then(function (ports) {
+              vow.callback(null, ports);
+            })
+            .catch(function (err) {
+              vow.callback(err, null);
+            });
+        },
+        "should respond with the first three available ports (32768, 32769, 32770) if Promise are available": function (err, ports) {
+          if (typeof Promise !== 'function') {
+            assert.isTrue(!!err);
+            assert.equal(
+              err.message,
+              'Native promise support is not available in this version of node.' +
+              'Please install a polyfill and assign Promise to global.Promise before calling this method'
+            );
+            return;
+          }
+          if (err) { debugVows(err); }
+          assert.isTrue(!err);
+          assert.deepEqual(ports, [32768, 32769, 32770]);
+        }
+      },
+    }
+  }
 }).export(module);