diff options
Diffstat (limited to 'node_modules/get-port/readme.md')
| -rw-r--r-- | node_modules/get-port/readme.md | 64 |
1 files changed, 0 insertions, 64 deletions
diff --git a/node_modules/get-port/readme.md b/node_modules/get-port/readme.md deleted file mode 100644 index 72c1fbc01..000000000 --- a/node_modules/get-port/readme.md +++ /dev/null @@ -1,64 +0,0 @@ -# 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) |