# @conarium-ai/mask 中文文档

规范地址：https://npmcn.com/package/%40conarium-ai/mask/

版本：0\.3\.5
npm 元数据更新时间：2026-10-29T11:59:50.459Z
中文译文更新时间：2026-11-14T08:04:26.585Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40conarium-ai/mask
原文对照：https://npmcn.com/package/%40conarium-ai/mask/?lang=original
项目主页：https://github.com/dogrucanemek-alt/conarium
源码仓库：https://github.com/dogrucanemek-alt/conarium

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

- 包体积（解压后）：473 kB，163 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2026-10-28T13:29:22.883Z
- 最新版本发布：2026-10-29T11:59:49.701Z
- 近 30 天下载量：2109（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

Conarium伪装引擎作为库,由与@conarium-ai/core相同的来源所建.

## 安装

```sh
npm install @conarium-ai/mask
```

也可以使用：`pnpm add @conarium-ai/mask`、`yarn add @conarium-ai/mask`、`bun add @conarium-ai/mask`

## README

# @ comarium-ai/ mask (韩语)

作为图书馆的Conarium的口罩引擎. 来源与 `@conarium-ai/core`;这个软件包只是那个引擎.

```bash
npm install @conarium-ai/mask
```

```js
import { maskField } from '@conarium-ai/mask'

const text = 'mail ayse.yilmaz@example.com TCKN 10000000146'
const r = maskField(text, { pipeline: 'text', only: ['tckn'] })
console.log(JSON.stringify({ text: r.text, classes: r.classes, masked: r.masked }, null, 2))
```

实例的实际产出 :

```
{
  "text": "mail ayse.yilmaz@example.com TCKN [MASKED_PII]",
  "classes": {
    "email": 1,
    "tckn": 1
  },
  "masked": {
    "tckn": 1
  }
}
```

`maskField` 报告这些类名 : `email`, (中文(简体) ), `entity-email`, (中文(简体) ), `phone`, (中文(简体) ), `tckn`, (中文(简体) ), `card`, (中文(简体) ), `ssn`, (中文(简体) ), `iban`, (中文(简体) ), `mrz`, (中文(简体) ), `ip`, (中文(简体) ), `secret`, (中文(简体) ), `connection`, (中文(简体) ), `bearer`, (中文(简体) ), `labelled-secret`, (中文(简体) ), `name`, (中文(简体) ), `embedded`, (中文(简体) ), `custom`。 。 。 .

探测器错过了它无法识别的东西。 见 `LIMITATIONS.md` 在仓库.

## 常见问题

### @conarium-ai/mask 是什么？

Conarium伪装引擎作为库,由与@conarium-ai/core相同的来源所建\.

### 如何安装 @conarium-ai/mask？

在项目目录运行 npm install @conarium-ai/mask，或使用 pnpm add / yarn add / bun add。

### @conarium-ai/mask 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @conarium-ai/mask 支持 ESM 还是 CommonJS？

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

### @conarium-ai/mask 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @conarium-ai/mask 可以商用吗？

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

### @conarium-ai/mask 的下载量有多少？

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

### @conarium-ai/mask 还在维护吗？

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