@funboxteam/free-port-finder

中文文档
4.0.0发布于 2023/06/06MITCommonJS零依赖近 30 天下载 2796

用于检查端口可用性的小工具

中文使用文档
文档目录4 节
  1. 理由
  2. 安装
  3. 使用量
  4. 如何运作

@funboxteam/free-port-finder (英语)

npm

包会检查通过端口的可用性,或者试图找到从通过端口开始的第一个可用的端口.

{\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}你觉得呢

理由

当您在本地主机启动 TCP( 或 HTTP) 服务器时, 您想要确定理想的端口没有被占用 或者你根本不在乎 想要买第一个.

这个小工具承担着这项任务.

安装

npm install --save-dev @funboxteam/free-port-finder

使用量

findFreePort(port: number, host?: string): Promise<number> 搜索从通过端口开始的现有端口 :

const { findFreePort } = require('@funboxteam/free-port-finder');

const port = 3000;

findFreePort(port)
  .then(freePort => {
    config.devServer.port = freePort;
  });

isPortFree(port: number, host?: string): Promise<bool> 检查通过端口的可用性 :

const { isPortFree } = require('@funboxteam/free-port-finder');

const port = 3000;

isPortFree(port)
  .then(isFree => {
    if (isFree) {
      // start
    } else {
      // cancel
    }
  });

可以通过主机值作为第二个参数. 默认主机值为 '0.0.0.0'。 。 。 .

检查指定主机上的端口是否可用 :

const { isPortFree } = require('@funboxteam/free-port-finder');

const port = 3000;
const host = '127.0.0.1';

isPortFree(port, host)
  .then(isFree => {
    if (isFree) {
      // start
    } else {
      // cancel
    }
  });

如何运作

为了了解端口是否自由,这个软件包试图 在指定的端口运行 TCP 服务器。 如果服务器启动, 包会杀死 它和信号 端口是免费的。 如果一个 EADDRINUSE 出错,它发出信号 港口正忙着 如果发生其他出错,则包会丢出.

这种解决办法既有利又不利.

计数 :
在一些操作系统不正确 SO_REUSEADDR 处理是可能的,自由端口可以 显示为繁忙(反之亦然).

职业:
可以走另一条路,尝试连接插座 指定地址,而不是运行服务器。 但在这种情况下, 连接到套接字可能会启动某种进程 这有可能是不可逆转的。 因此, 目前的解决办法是安全的.

Sponsored by FunBox

版本与发布记录

@funboxteam/free-port-finder 共发布 4 个版本,首次发布于 2020/07/16;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.0.0latest2023/06/063 年前
3.1.12021/06/105 年前
3.1.02020/08/106 年前
3.0.02020/07/166 年前

关于 @funboxteam/free-port-finder 的常见问题

@funboxteam/free-port-finder 是什么?

用于检查端口可用性的小工具

如何安装 @funboxteam/free-port-finder?

在项目目录运行 npm install @funboxteam/free-port-finder,或使用 pnpm add / yarn add / bun add。

@funboxteam/free-port-finder 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/funboxteam__free-port-finder 是否存在。

@funboxteam/free-port-finder 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@funboxteam/free-port-finder 可以商用吗?

@funboxteam/free-port-finder 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@funboxteam/free-port-finder 的下载量有多少?

根据 npm 官方下载统计,@funboxteam/free-port-finder 在 2026/10/16 – 2026/11/14 这 30 天内被下载 2,796 次,日均约 93 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@funboxteam/free-port-finder 还在维护吗?

最新版本 4.0.0 发布于 2023/06/06(3 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/07/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。