Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
D

detect-port

> 编程语言
Open source

Node.js module to detect available ports of the system.

395 stars0 likes1 views
WebsiteGitHub

About

Node.js module to detect available ports of the system.

detect-port

NPM version Test coverage Known Vulnerabilities npm download Node.js Version

Node.js implementation of port detector

Who are using or has used

  • ⭐⭐⭐eggjs/egg
  • ⭐⭐⭐alibaba/ice
  • ⭐⭐⭐alibaba/uirecorder
  • ⭐⭐⭐facebook/create-react-app
  • ⭐⭐⭐facebook/flipper
  • ⭐⭐⭐umijs/umi
  • ⭐⭐⭐gatsbyjs/gatsby
  • ⭐⭐⭐electron-react-boilerplate/electron-react-boilerplate
  • ⭐⭐⭐zeit/micro
  • ⭐⭐⭐rails/webpacker
  • ⭐⭐⭐storybookjs/storybook

For more

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

typescript
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

Contributors

Made with contributors-img.

Issues· 1 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

TypeScriptdetectorfreenodejsport

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 17, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言