Installation
$ [sudo] npm install portfinder
Usage
The portfinder
module has a simple interface:
var portfinder = ;portfinder;
Or with promise (if Promise are supported) :
const portfinder = ;portfinder;
If portfinder.getPortPromise()
is called on a Node version without Promise (<4), it will throw an Error unless Bluebird or any Promise pollyfill is used.
Ports search scope
By default portfinder
will start searching from 8000
and scan until maximum port number (65535
) is reached.
You can change this globally by setting:
portfinderbasePort = 3000; // default: 8000portfinderhighestPort = 3333; // default: 65535
or by passing optional options object on each invocation:
portfinder;
Run Tests
$ npm test