# @cdssnc/sanitize-pii 中文文档

规范地址：https://npmcn.com/package/%40cdssnc/sanitize-pii/

版本：2\.3\.1
npm 元数据更新时间：2026-11-04T18:21:48.869Z
中文译文更新时间：2026-11-09T06:45:15.839Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cdssnc/sanitize-pii
原文对照：https://npmcn.com/package/%40cdssnc/sanitize-pii/?lang=original
源码仓库：https://github.com/cds-snc/sanitize-pii

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

- 包体积（解压后）：91.6 kB，35 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-07-24T18:58:00.537Z
- 最新版本发布：2026-11-04T18:21:48.337Z
- 近 30 天下载量：6709（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 5 个）

## 中文简介

从文本中删除个人可识别信息的脚本模块

## 安装

```sh
npm install @cdssnc/sanitize-pii
```

也可以使用：`pnpm add @cdssnc/sanitize-pii`、`yarn add @cdssnc/sanitize-pii`、`bun add @cdssnc/sanitize-pii`

## README

# 将 PII 管理化

用于从文本中删除个人可识别信息的TypeScript模块(PII). 此模块默认删除的 PII 在 [`src/patterns.ts`](https://npmcn.com/package/%40cdssnc/sanitize-pii/src/patterns.ts)。 。 。 .

## 安装

```sh
npm install @cdssnc/sanitize-pii
```

## 快开始

```typescript
import { sanitizePii, PiiSanitizer } from '@cdssnc/sanitize-pii';

// Simple usage with default patterns
const text = "Contact me at (555) 123-4567 with Account ID 1234";
const sanitized = sanitizePii(text);
console.log(sanitized);
// Output: "Contact me at [Redacted: phone_number] with Account ID 1234"

// Sanitizer with custom replacement template and pattern
const sanitizer = new PiiSanitizer({
  replacementTemplate: '***{name}***',
  patterns: [
    {
      name: 'account_id',
      regex: /\bAccount\sID\s\d{4}\b/g,
    }
  ]
});

const result = sanitizer.sanitize(text);
console.log(result);
// Output: "Contact me at ***phone_number*** with ***account_id***"
```

您也可以在浏览器中直接使用该模块,其CDN如下:

```html
<script src="https://cdn.jsdelivr.net/npm/@cdssnc/sanitize-pii@1.1.1/dist/umd/sanitize-pii.min.js"></script>
<script>
  const textareas = document.querySelectorAll('textarea');
  textareas.forEach(textarea => {
    textarea.value = sanitizePii(textarea.value);
  });
</script>
```

## 发展

A 类 [调试器](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers) 已提供创建本地或代码空间等环境。 如果提交拉动请求,您可以运行以下程序,以确保一切工作如所预期:

```sh
npm ci
npm test
npm run lint
npm run format
npm run build
npm run test:build
```

## 常见问题

### @cdssnc/sanitize-pii 是什么？

从文本中删除个人可识别信息的脚本模块

### 如何安装 @cdssnc/sanitize-pii？

在项目目录运行 npm install @cdssnc/sanitize-pii，或使用 pnpm add / yarn add / bun add。

### @cdssnc/sanitize-pii 支持 TypeScript 吗？

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

### @cdssnc/sanitize-pii 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cdssnc/sanitize-pii 可以商用吗？

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

### @cdssnc/sanitize-pii 的下载量有多少？

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

### @cdssnc/sanitize-pii 还在维护吗？

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