Portscanner 项目技术文档

1. 安装指南

1.1 安装环境要求

• 确保你已经安装了 Node.js 和 npm。
• 项目依赖于 Node.js 环境，因此请确保你的系统上已经安装了 Node.js。

1.2 安装步骤

1. 打开终端或命令行工具。
2. 使用以下命令安装 portscanner 模块：

   npm install portscanner
   

2. 项目的使用说明

2.1 基本使用

portscanner 模块提供了多种功能，用于检查端口的状态、查找可用端口或被占用的端口。以下是一些基本的使用示例：

2.1.1 检查单个端口的状态

var portscanner = require('portscanner');

portscanner.checkPortStatus(3000, '127.0.0.1', function(error, status) {
  // 状态为 'open' 表示端口正在使用中，'closed' 表示端口可用
  console.log(status);
});

2.1.2 查找第一个可用端口

portscanner.findAPortNotInUse(3000, 3010, '127.0.0.1', function(error, port) {
  console.log('AVAILABLE PORT AT: ' + port);
});

2.1.3 查找第一个被占用的端口

portscanner.findAPortInUse(3000, 3010, '127.0.0.1', function(error, port) {
  console.log('PORT IN USE AT: ' + port);
});

2.2 高级使用

2.2.1 检查多个端口的状态

portscanner.findAPortInUse([3000, 3005, 3006], '127.0.0.1', function(error, port) {
  console.log('PORT IN USE AT: ' + port);
});

2.2.2 不指定主机地址

portscanner.findAPortNotInUse(3000, 4000, function(error, port) {
  console.log('PORT IN USE AT: ' + port);
});

2.2.3 使用 Promise

portscanner.findAPortNotInUse(3000, 4000).then(function(port) {
  console.log('PORT IN USE AT: ' + port);
});

3. 项目API使用文档

3.1 checkPortStatus(port, host, callback)

• 功能: 检查指定端口的状态。
• 参数:
  • port: 要检查的端口号。
  • host: 目标主机地址，默认为 '127.0.0.1'。
  • callback: 回调函数，接收两个参数 error 和 status，status 为 'open' 或 'closed'。

3.2 findAPortNotInUse(startPort, endPort, host, callback)

• 功能: 查找第一个可用的端口。
• 参数:
  • startPort: 起始端口号。
  • endPort: 结束端口号。
  • host: 目标主机地址，默认为 '127.0.0.1'。
  • callback: 回调函数，接收两个参数 error 和 port，port 为找到的可用端口号。

3.3 findAPortInUse(startPort, endPort, host, callback)

• 功能: 查找第一个被占用的端口。
• 参数:
  • startPort: 起始端口号。
  • endPort: 结束端口号。
  • host: 目标主机地址，默认为 '127.0.0.1'。
  • callback: 回调函数，接收两个参数 error 和 port，port 为找到的被占用端口号。

3.4 findAPortInUse(ports, host, callback)

• 功能: 检查指定端口列表中第一个被占用的端口。
• 参数:
  • ports: 端口号数组。
  • host: 目标主机地址，默认为 '127.0.0.1'。
  • callback: 回调函数，接收两个参数 error 和 port，port 为找到的被占用端口号。

4. 项目安装方式

4.1 使用 npm 安装

npm install portscanner

4.2 测试安装

安装完成后，可以使用以下命令运行测试：

npm test

通过以上步骤，你可以成功安装并使用 portscanner 模块来检查端口状态、查找可用端口或被占用的端口。