https://github.com/node-modules/detect-port
Node.js module to detect available ports of the system.
https://github.com/node-modules/detect-port
detector free nodejs port
Last synced: about 1 month ago
JSON representation
Node.js module to detect available ports of the system.
- Host: GitHub
- URL: https://github.com/node-modules/detect-port
- Owner: node-modules
- License: mit
- Created: 2015-05-30T02:50:53.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-11T02:27:19.000Z (4 months ago)
- Last Synced: 2025-03-08T10:02:44.990Z (about 1 month ago)
- Topics: detector, free, nodejs, port
- Language: TypeScript
- Homepage:
- Size: 123 KB
- Stars: 384
- Watchers: 14
- Forks: 25
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs - detect-port - Node.js implementation of port detector.  (Repository / Network)
- awesome-github-star - detect-port - modules | 354 | (JavaScript)
- awesome-packages - detect-port
README
# detect-port
[![NPM version][npm-image]][npm-url]
[](https://github.com/node-modules/detect-port/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[![Node.js Version][node-version-image]][node-version-url]
[npm-image]: https://img.shields.io/npm/v/detect-port.svg?style=flat-square
[npm-url]: https://npmjs.org/package/detect-port
[codecov-image]: https://codecov.io/gh/node-modules/detect-port/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/node-modules/detect-port
[snyk-image]: https://snyk.io/test/npm/detect-port/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/detect-port
[download-image]: https://img.shields.io/npm/dm/detect-port.svg?style=flat-square
[download-url]: https://npmjs.org/package/detect-port
[node-version-image]: https://img.shields.io/node/v/detect-port.svg?style=flat-square
[node-version-url]: https://nodejs.org/en/download/
> Node.js implementation of port detector
## Who are using or has used
- ⭐⭐⭐[eggjs/egg](//github.com/eggjs/egg)
- ⭐⭐⭐[alibaba/ice](//github.com/alibaba/ice)
- ⭐⭐⭐[alibaba/uirecorder](//github.com/alibaba/uirecorder)
- ⭐⭐⭐[facebook/create-react-app](//github.com/facebook/create-react-app/blob/main/packages/react-dev-utils/package.json)
- ⭐⭐⭐[facebook/flipper](//github.com/facebook/flipper)
- ⭐⭐⭐[umijs/umi](//github.com/umijs/umi)
- ⭐⭐⭐[gatsbyjs/gatsby](//github.com/gatsbyjs/gatsby)
- ⭐⭐⭐[electron-react-boilerplate/electron-react-boilerplate](//github.com/electron-react-boilerplate/electron-react-boilerplate)
- ⭐⭐⭐[zeit/micro](//github.com/zeit/micro)
- ⭐⭐⭐[rails/webpacker](//github.com/rails/webpacker)
- ⭐⭐⭐[storybookjs/storybook](//github.com/storybookjs/storybook)
[For more](//github.com/node-modules/detect-port/network/dependents)
## Usage
```bash
npm i detect-port
```
CommonJS
```javascript
const { detect } = require('detect-port');
detect(port)
.then(realPort => {
if (port == realPort) {
console.log(`port: ${port} was not occupied`);
} else {
console.log(`port: ${port} was occupied, try port: ${realPort}`);
}
})
.catch(err => {
console.log(err);
});
```
ESM and TypeScript
```ts
import { detect } from 'detect-port';
detect(port)
.then(realPort => {
if (port == realPort) {
console.log(`port: ${port} was not occupied`);
} else {
console.log(`port: ${port} was occupied, try port: ${realPort}`);
}
})
.catch(err => {
console.log(err);
});
```
## Command Line Tool
```bash
npm i detect-port -g
```
### Quick Start
```bash
# get an available port randomly
$ detect
# detect pointed port
$ detect 80
# output verbose log
$ detect --verbose
# more help
$ detect --help
```
## FAQ
Most likely network error, check that your `/etc/hosts` and make sure the content below:
```bash
127.0.0.1 localhost
255.255.255.255 broadcasthost
::1 localhost
```
## License
[MIT](LICENSE)
## Contributors
[](https://github.com/node-modules/detect-port/graphs/contributors)
Made with [contributors-img](https://contrib.rocks).