Get an available TCP port
$ npm install get-port
const getPort = require('get-port');
(async () => {
console.log(await getPort());
//=> 51402
})();Pass in a preferred port:
(async () => {
console.log(await getPort({port: 3000}));
// Will use 3000 if available, otherwise fall back to a random port
})();Pass in an array of preferred ports:
(async () => {
console.log(await getPort({port: [3000, 3001, 3002]}));
// Will use any element in the preferred ports array if available, otherwise fall back to a random port
})();Use makeRange helper in case you need to select port from a range to generate an array of ports:
(async () => {
console.log(await getPort({port: getPort.makeRange(3000, 3003)}));
// Will use any port >= 3000, port < 3003, otherwise fall back to a random port
})();Returns a Promise for a port number.
Type: Object
Type: number | number[]
A preferred port or an array of preferred ports to use.
Type: string
The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.
Type: number
Port to start range from, inclusive.
Type: number
Port to end range at, exclusive.
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.
- get-port-cli - CLI for this module
MIT © Sindre Sorhus