# @cloudron/ipaddr 中文文档

规范地址：https://npmcn.com/package/%40cloudron/ipaddr/

版本：1\.1\.0
npm 元数据更新时间：2026-06-04T10:06:42.590Z
中文译文更新时间：2026-11-10T03:29:08.450Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cloudron/ipaddr
原文对照：https://npmcn.com/package/%40cloudron/ipaddr/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.7 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2026-06-04T09:57:47.568Z
- 最新版本发布：2026-06-04T10:06:42.457Z
- 近 30 天下载量：5217（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

IP 地址和 CIDR 帮助

## 安装

```sh
npm install @cloudron/ipaddr
```

也可以使用：`pnpm add @cloudron/ipaddr`、`yarn add @cloudron/ipaddr`、`bun add @cloudron/ipaddr`

## README

# @ cloudron/ ipaddr (英语)

Cloudron服务使用的小IP地址和CIDR帮助器.

## 安装

```bash
npm install @cloudron/ipaddr
```

## 使用量

```js
import ipaddr, { isValid, isValidCIDR, isEqual, includes, parseCIDR } from '@cloudron/ipaddr';

isValid('1.2.3.4'); // true
isValidCIDR('172.18.0.0/16'); // true
isEqual('::ffff:1.2.3.4', '1.2.3.4'); // true
includes('10.0.0.0/8', '10.1.2.3'); // true
parseCIDR('172.18.0.0/16'); // { ip: '172.18.0.0', prefix: 16, family: 4 }

// default export has the same helpers
ipaddr.isValid('::1'); // true
```

## API 密码

### `isValid(ip)`

回返 `true` 若为 `ip` 是有效的 IPv4 或 IPv6 地址, 否则 `false`。 。 。 .

### `parseCIDR(cidr)`

解析 CIDR 字符串并返回 `{ ip, prefix, family }` (单位:千美元)`family` 实值 `4` 或者说 `6`) (中文(简体) ).

回返 `null` 用于无效的 CIDR 输入.

### `isValidCIDR(cidr)`

回返 `true` 若为 `cidr` 是有效的 CIDR 字符串( IPv4 或 IPv6) , 否则 `false`。 。 。 .

### `isEqual(ip1, ip2)`

比较两个 IP 地址并返回 `true` 如果它们代表同一个地址.

这使得不同的文字形式(例如IPv6简手和IPv4-mapped IPv6)正常化.

### `includes(cidr, ip)`

回返 `true` 若为 `ip` 是在提供的 `cidr` 范围,否则 `false`。 。 。 .

## 页:1

-   所有函数都需要字符串输入 .
-   返回无效的值 `false` 用于验证和比较检查.
-   已命名的出口和默认的出口都得到支持.

## 常见问题

### @cloudron/ipaddr 是什么？

IP 地址和 CIDR 帮助

### 如何安装 @cloudron/ipaddr？

在项目目录运行 npm install @cloudron/ipaddr，或使用 pnpm add / yarn add / bun add。

### @cloudron/ipaddr 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cloudron\_\_ipaddr 是否存在。

### @cloudron/ipaddr 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cloudron/ipaddr 可以商用吗？

@cloudron/ipaddr 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudron/ipaddr 的下载量有多少？

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

### @cloudron/ipaddr 还在维护吗？

最新版本 1\.1\.0 发布于 2026/06/04（5 个月前）；至今共发布 2 个版本，其中过去 12 个月发布了 2 个；首次发布于 2026/06/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。