get-port ![Build Status](https://travis-ci.org/sindresorhus/get-port.svg?branch=master)
Get an available TCP port
Install
$ npm install get-port
Usage
const getPort = require('get-port');
(async () => {
console.log(await getPort());
})();
Pass in a preferred port:
(async () => {
console.log(await getPort({port: 3000}));
})();
Pass in an array of preferred ports:
(async () => {
console.log(await getPort({port: [3000, 3001, 3002]}));
})();
Use the makeRange()
helper in case you need a port in a certain range:
(async () => {
console.log(await getPort({port: getPort.makeRange(3000, 3100)}));
})();
API
getPort([options])
Returns a Promise
for a port number.
options
Type: Object
port
Type: number | Iterable<number>
A preferred port or an iterable of preferred ports to use.
host
Type: string
The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.
getPort.makeRange(from, to)
Make a range of ports from
...to
.
Returns an Iterable
for ports in the given range.
from
Type: number
First port of the range. Must be in the range 1024
...65535
.
to
Type: number
Last port of the range. Must be in the range 1024
...65535
and must be greater than from
.
Beware
There is a very tiny chance of a race condition if another service starts using the same port number as you in between the time you get the port number and you actually start using it.
Related
License
MIT © Sindre Sorhus