diff options
Diffstat (limited to 'node_modules/get-port/readme.md')
-rw-r--r-- | node_modules/get-port/readme.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/get-port/readme.md b/node_modules/get-port/readme.md new file mode 100644 index 000000000..292b8c3d7 --- /dev/null +++ b/node_modules/get-port/readme.md @@ -0,0 +1,41 @@ +# get-port [](https://travis-ci.org/sindresorhus/get-port) + +> Get an available port + + +## Install + +``` +$ npm install --save get-port +``` + + +## Usage + +```js +const getPort = require('get-port'); + +getPort().then(port => { + console.log(port); + //=> 51402 +}); +``` + +Optionally, pass in a preferred port: + +```js +getPort(3000).then(port => { + console.log(port); + // Will use 3000 if available, otherwise fall back to a random port +}); +``` + + +## Related + +- [get-port-cli](https://github.com/sindresorhus/get-port-cli) - CLI for this module + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |