diff options
Diffstat (limited to 'node_modules/get-port/readme.md')
-rw-r--r-- | node_modules/get-port/readme.md | 27 |
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 |