node package manager
Love JavaScript? Your insights can make it even better. Take the 2017 JavaScript Ecosystem Survey »

get-port

get-port Build Status

Get an available port

Install

$ npm install get-port

Usage

const getPort = require('get-port');
 
getPort().then(port => {
    console.log(port);
    //=> 51402 
});

Optionally, pass in a preferred port:

getPort({port: 3000}).then(port => {
    console.log(port);
    // Will use 3000 if available, otherwise fall back to a random port 
});

API

getPort([options])

Returns a Promise for a port number.

options

Type: Object

port

Type: number

The preferred port to use.

host

Type: string

The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.

Related

License

MIT © Sindre Sorhus