# @aegisjsproject/sanitizer 中文文档

规范地址：https://npmcn.com/package/%40aegisjsproject/sanitizer/

版本：0\.3\.0
npm 元数据更新时间：2026-06-14T14:45:12.167Z
中文译文更新时间：2026-11-06T10:46:49.592Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aegisjsproject/sanitizer
原文对照：https://npmcn.com/package/%40aegisjsproject/sanitizer/?lang=original
项目主页：https://github.com/AegisJSProject/sanitizer#readme
源码仓库：https://github.com/AegisJSProject/sanitizer

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

- 包体积（解压后）：308 kB，46 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2024-03-27T03:40:22.120Z
- 最新版本发布：2026-06-14T14:45:11.876Z
- 近 30 天下载量：3424（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 5 个）

## 中文简介

包含各种消毒器配置的 Sanitize API 的多填充

## 安装

```sh
npm install @aegisjsproject/sanitizer
```

也可以使用：`pnpm add @aegisjsproject/sanitizer`、`yarn add @aegisjsproject/sanitizer`、`bun add @aegisjsproject/sanitizer`

## README

# `@aegisjsproject/sanitizer`

[卫生剂 API](https://github.com/WICG/sanitizer-api/) 多填充配置( c)

[![CodeQL](https://github.com/AegisJSProject/sanitizer/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/AegisJSProject/sanitizer/actions/workflows/codeql-analysis.yml) ![Node CI](https://github.com/AegisJSProject/sanitizer/workflows/Node%20CI/badge.svg) ![Lint Code Base](https://github.com/AegisJSProject/sanitizer/workflows/Lint%20Code%20Base/badge.svg)

[![GitHub license](https://img.shields.io/github/license/AegisJSProject/sanitizer.svg)](https://github.com/AegisJSProject/sanitizer/blob/master/LICENSE) [![GitHub last commit](https://img.shields.io/github/last-commit/AegisJSProject/sanitizer.svg)](https://github.com/AegisJSProject/sanitizer/commits/master) [![GitHub release](https://img.shields.io/github/release/AegisJSProject/sanitizer?logo=github)](https://github.com/AegisJSProject/sanitizer/releases) [![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)

[![npm](https://img.shields.io/npm/v/@aegisjsproject/sanitizer)](https://www.npmjs.com/package/@aegisjsproject/sanitizer) ![node-current](https://img.shields.io/node/v/@aegisjsproject/sanitizer) ![npm bundle size gzipped](https://img.shields.io/bundlephobia/minzip/@aegisjsproject/sanitizer) [![npm](https://img.shields.io/npm/dw/@aegisjsproject/sanitizer?logo=npm)](https://www.npmjs.com/package/@aegisjsproject/sanitizer)

[![GitHub followers](https://img.shields.io/github/followers/shgysk8zer0.svg?style=social)](https://github.com/shgysk8zer0) ![GitHub forks](https://img.shields.io/github/forks/AegisJSProject/sanitizer.svg?style=social) ![GitHub stars](https://img.shields.io/github/stars/AegisJSProject/sanitizer.svg?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)

[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")

* * *

-   [行为守则](https://npmcn.com/package/%40aegisjsproject/sanitizer/.github/CODE_OF_CONDUCT.md)
-   [捐款](https://npmcn.com/package/%40aegisjsproject/sanitizer/.github/CONTRIBUTING.md)
-   [安全政策](https://npmcn.com/package/%40aegisjsproject/sanitizer/.github/SECURITY.md)

## AegisJS 卫生项目

这是一个库的多填充( M) [卫生剂 API](https://github.com/WICG/sanitizer-api/)。 。 。 .

它提供了最低限度的多填充量 `Element.prototype.setHTML()` 打开 `Document.parseHTML()`, (中文(简体) ), 以及HTML,SVG,和MathML的配置文件. 但请注意 在这些消毒方法中默认的消毒器配置 _仅限_ 默认支持 HTML.

“ base” 配置( 不是默认使用的内容) _事实_ 添加对 `<svg>`, (中文(简体) ), 和“ 完整” 配置支持 `<svg>` 打开 `<math>`。 。 。 .

这有助于通过以下方式防止XSS:

-   剥离事件属性, 如 `onclick`
-   删除不安全的 URL 属性 `<a href="javascript:...">`
-   防止添加 `<script>`s 和 `<style>`编号
-   删除其他潜在危险元素属性( T)

### 示例

```js
import '@aegijsproject/sanitizer/polyfill.js';
import { sanitizer } from '@aegisjsproject/sanitizer/config/base.js';

document.body.setHTML(`
  <header id="header">
    <h1 onclick="alert(location.href)" data-foo="bar">Hello, World!</h1>
  </header>
  <nav id="nav" class="flex row">
    <button type="button" popovertarget="bacon" popovertargetaction="show" accesskey="b">Show Bacon Ipsum</button>
    <a href="#foo">Normal Link</a>
    <a href="javascript:alert('javascript:')"><code>javascript:</code> Link</a>
    <a href="data:text/plain,Not%20Allowed" target="_blank"><code>data:</code> Link</a>
    <a href="${URL.createObjectURL(file)}" target="_blank"><code>blob:</code> Link</a>
  </nav>
  <main id="main"></main>
  <div popover="auto" id="bacon">
    <div>
      <b>Bacon Ipsum</b>
      <button type="button" popovertarget="bacon" popovertargetaction="hide">
        <svg xmlns="http://www.w3.org/2000/svg" width="12" height="16" viewBox="0 0 12 16" fill="currentColor" role="presentation" aria-label="Close Popover">
          <path fill-rule="evenodd" d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48L7.48 8z"/>
        </svg>
      </button>
    </div>
    <p>Bacon ipsum dolor amet pork belly frankfurter drumstick jowl brisket capicola
      short ribs.Cow chislic ham hock t-bone shoulder salami rump corned beef spare
      ribs prosciutto bresaola picanha drumstick. Swine tail pork belly ribeye beef
      kielbasa. Beef cupim ball tip pastrami spare ribs strip steak tongue salam
      venison. Venison cupim meatball strip steak meatloaf prosciutto buffalo
      frankfurter hamburger flank boudin.</p>
  </div>
`, sanitizer);
```

### 限制允许的内容(如评论)

```js
const sanitizer = {
  elements: ['span', 'div', 'p', 'code', 'pre', 'blockquote', 'img', 'a'],
  attributes: ['href', 'src', 'loading', 'height', 'width', 'class', 'alt', 'target'],
};

fetch('https://api.example.com/comments')
  .then(resp => resp.json())
  .then(comments => {
    document.querySelector('.comments').append(...comments.map(comment => {
      const el = document.createElement('div');
      el.setHTML(comment.body, sanitizer);
      return el;
    }));
  });
```

### 添加到允许的元素/ 属性

```js
import { elements, attributes } from '@aegisjsproject/sanitizer/config/html.js';

const sanitizer = {
  elements: ['hello-world', ...elements],
  attributes: ['foo', ...attributes],
};

document.querySelector('.container').setHTML(`
  <hello-world foo="bar"></hello-world>
`, sanitizer);
```

### 默认强制化( 如 `innerHTML`,支持的地方)

```js
if ('trustedTypes' in globalThis) {
  trustedTypes.createPolicy('default', {
    createHTML(input) {
      const el = document.createElement('div');
      el.setHTML(input);
      return el.innerHTML;
    }
  });
}
```

## 常见问题

### @aegisjsproject/sanitizer 是什么？

包含各种消毒器配置的 Sanitize API 的多填充

### 如何安装 @aegisjsproject/sanitizer？

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

### @aegisjsproject/sanitizer 支持 TypeScript 吗？

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

### @aegisjsproject/sanitizer 支持 ESM 还是 CommonJS？

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

### @aegisjsproject/sanitizer 需要什么版本的 Node\.js？

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

### @aegisjsproject/sanitizer 可以商用吗？

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

### @aegisjsproject/sanitizer 的下载量有多少？

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

### @aegisjsproject/sanitizer 还在维护吗？

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