ipaddr.js 使用与技术文档

本文档旨在详细介绍如何安装、使用以及API调用ipaddr.js，这是一个用于在JavaScript环境中操作IP地址的轻量级库。

1. 安装指南

ipaddr.js可以通过以下方式安装：

• 使用npm：

  npm install ipaddr.js
  

• 使用bower：

  bower install ipaddr.js
  

对于老版本的Node.js（10以下版本），请使用1.x版本。

2. 项目的使用说明

ipaddr.js提供了对IPv4和IPv6地址的解析、验证、匹配等功能。以下是基本的使用示例：

const ipaddr = require('ipaddr.js');

// 验证IP地址
const isValid = ipaddr.isValid('192.168.1.1'); // true

// 验证CIDR地址
const isValidCIDR = ipaddr.isValidCIDR('192.168.1.1/24'); // true

// 解析IP地址
const parsed = ipaddr.parse('192.168.1.1');
console.log(parsed.toString()); // 192.168.1.1

3. 项目API使用文档

ipaddr.js定义了一个全局对象ipaddr，并提供了一系列方法和类。

Global Methods

• ipaddr.isValid(string): 检查字符串是否为有效的IPv4或IPv6地址。
• ipaddr.isValidCIDR(string): 检查字符串是否为有效的CIDR表示法的IPv4或IPv6地址。
• ipaddr.parse(string): 解析IP地址，返回一个IP地址对象。
• ipaddr.process(string): 解析IP地址，自动将IPv4-mapped IPv6地址转换为IPv4地址。

类方法

ipaddr.IPv6 和 ipaddr.IPv4

两个类分别表示IPv6和IPv4地址，它们具有以下方法和属性：

• addr.kind(): 返回地址类型，"ipv6" 或 "ipv4"。
• addr.toString(): 将地址转换为字符串表示形式。
• addr.match(range, bits): 检查地址是否在特定的CIDR范围内。
• addr.range(): 返回地址的预定义范围名称。
• addr.toByteArray(): 将地址转换为字节表示形式。

IPv6特定的方法：

• addr.toNormalizedString(): 返回地址的规范化字符串表示形式。
• addr.isIPv4MappedAddress(): 检查地址是否为IPv4映射的地址。
• addr.toIPv4Address(): 返回对应的IPv4地址对象。

IPv4特定的方法：

• prefixLengthFromSubnetMask(string): 从子网掩码返回CIDR前缀长度。
• subnetMaskFromPrefixLength(number): 从CIDR前缀长度返回子网掩码。
• broadcastAddressFromCIDR(string): 从CIDR返回广播地址。
• networkAddressFromCIDR(string): 从CIDR返回网络地址。

转换方法

IPv4和IPv6对象都提供了以下转换方法：

• fromByteArray(array): 从字节数组创建IPv4或IPv6对象。
• toByteArray(): 将地址转换为网络字节顺序的字节数组。

4. 项目安装方式

ipaddr.js的安装方式已在安装指南中详细介绍，可通过npm或bower进行安装。对于不同版本的Node.js，需要选择合适的版本进行安装。

以上就是关于ipaddr.js的使用与技术文档，希望对您有所帮助。