aboutsummaryrefslogtreecommitdiff
path: root/node_modules/get-port/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-12-27 19:33:54 +0100
committerFlorian Dold <florian.dold@gmail.com>2017-12-27 19:34:16 +0100
commit0e6de2c31dbf8c21277481f112e99c52b913940f (patch)
tree91789032de3b8eec9d789acd1323f25fc5d08422 /node_modules/get-port/readme.md
parentceda0da31ad542c598c68146ae0712ca03df3d71 (diff)
node_modules
Diffstat (limited to 'node_modules/get-port/readme.md')
-rw-r--r--node_modules/get-port/readme.md27
1 files changed, 25 insertions, 2 deletions
diff --git a/node_modules/get-port/readme.md b/node_modules/get-port/readme.md
index 292b8c3d7..72c1fbc01 100644
--- a/node_modules/get-port/readme.md
+++ b/node_modules/get-port/readme.md
@@ -6,7 +6,7 @@
## Install
```
-$ npm install --save get-port
+$ npm install get-port
```
@@ -24,13 +24,36 @@ getPort().then(port => {
Optionally, pass in a preferred port:
```js
-getPort(3000).then(port => {
+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