2017-05-28 00:38:50 +02:00
|
|
|
# get-port [![Build Status](https://travis-ci.org/sindresorhus/get-port.svg?branch=master)](https://travis-ci.org/sindresorhus/get-port)
|
|
|
|
|
|
|
|
> Get an available port
|
|
|
|
|
|
|
|
|
|
|
|
## Install
|
|
|
|
|
|
|
|
```
|
2017-12-27 19:33:54 +01:00
|
|
|
$ npm install get-port
|
2017-05-28 00:38:50 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
```js
|
|
|
|
const getPort = require('get-port');
|
|
|
|
|
|
|
|
getPort().then(port => {
|
|
|
|
console.log(port);
|
|
|
|
//=> 51402
|
|
|
|
});
|
|
|
|
```
|
|
|
|
|
|
|
|
Optionally, pass in a preferred port:
|
|
|
|
|
|
|
|
```js
|
2017-12-27 19:33:54 +01:00
|
|
|
getPort({port: 3000}).then(port => {
|
2017-05-28 00:38:50 +02:00
|
|
|
console.log(port);
|
|
|
|
// Will use 3000 if available, otherwise fall back to a random port
|
|
|
|
});
|
|
|
|
```
|
|
|
|
|
|
|
|
|
2017-12-27 19:33:54 +01:00
|
|
|
## 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.
|
|
|
|
|
|
|
|
|
2017-05-28 00:38:50 +02:00
|
|
|
## Related
|
|
|
|
|
|
|
|
- [get-port-cli](https://github.com/sindresorhus/get-port-cli) - CLI for this module
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|