@conarium-ai/mask

中文文档

0.3.5发布于 2026/10/29MITTypeScriptES Module近 30 天下载 2109

The Conarium masking engine as a library, built from the same source as @conarium-ai/core.

@conarium-ai/mask

The masking engine of Conarium as a library. Same source as @conarium-ai/core; this package is only that engine.

npm install @conarium-ai/mask

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

const text = 'mail [email protected] 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))

Real output of that example:

{
  "text": "mail [email protected] TCKN [MASKED_PII]",
  "classes": {
    "email": 1,
    "tckn": 1
  },
  "masked": {
    "tckn": 1
  }
}

maskField reports these class names: email, entity-email, phone, tckn, card, ssn, iban, mrz, ip, secret, connection, bearer, labelled-secret, name, embedded, custom.

A detector misses what it does not recognise. See LIMITATIONS.md in the repository.

版本与发布记录

@conarium-ai/mask 共发布 4 个版本，首次发布于 2026/10/28；过去 12 个月发布了 4 个版本。

版本	发布日期	距今
`0.3.5`latest	2026/10/29	15 天前
`0.3.4`	2026/10/29	15 天前
`0.3.3`	2026/10/28	16 天前
`0.0.0-stage`	2026/10/28	16 天前

关于 @conarium-ai/mask 的常见问题

@conarium-ai/mask 是什么？

The Conarium masking engine as a library, built from the same source as @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 和提交记录判断。