porti

porti

Node.js utility for obtaining random TCP ports

Installation

npm install porti --save

Usage

const porti = require('porti');

// Finding an unused port in a range of ports. If a range is not specified,
// Porti starts at port 1024 and stops when it has found an unused port.
// None of the properties in the first options argument are required.
porti.getUnusedPort({
  min: 2000,          // lower bound of random port range to select from
  max: 5000,          // upper bound of random port range to select from
}).then((port) => {
  ...
}).catch((err) => {
  ...
})

Synchronous API:

// Finding an unused port in a range of ports. If a range is not specified,
// Porti starts at port 1024 and stops when it has found an unused port.
// None of the properties in the first options argument are required.
const port = porti.getUnusedPortSync({
  min: 2000,          // lower bound of random port range to select from
  max: 5000,          // upper bound of random port range to select from
})