blob: 72c1fbc01fbf9ad2971441bc308faf8ce338bcc9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# get-port [](https://travis-ci.org/sindresorhus/get-port)
> Get an available port
## Install
```
$ npm install get-port
```
## Usage
```js
const getPort = require('get-port');
getPort().then(port => {
console.log(port);
//=> 51402
});
```
Optionally, pass in a preferred port:
```js
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
- [get-port-cli](https://github.com/sindresorhus/get-port-cli) - CLI for this module
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
