get-port
Get an available port
Last updated 7 months ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install get-port 
SYNC missed versions from official npm registry.

get-port Build Status

Get an available TCP port

Install

$ npm install get-port

Usage

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 the makeRange() helper in case you need a port in a certain range:

(async () => {
	console.log(await getPort({port: getPort.makeRange(3000, 3100)}));
	// Will use any port from 3000 to 3100, otherwise fall back to a random port
})();

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

Current Tags

  • 5.0.0                                ...           latest (7 months ago)

11 Versions

  • 5.0.0                                ...           7 months ago
  • 4.2.0                                ...           8 months ago
  • 4.1.0                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 3.2.0                                ...           2 years ago
  • 3.1.0                                ...           3 years ago
  • 3.0.0                                ...           3 years ago
  • 2.1.0                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.0.0                                ...           5 years ago
  • 0.1.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 1,276
This Week 2,394
This Month 11,428
Last Day 1,118
Last Week 6,902
Last Month 26,613
Dependencies (1)
Dev Dependencies (4)
Dependents (798)

Copyright 2014 - 2016 © taobao.org |