# dom-serializer 中文文档

规范地址：https://npmcn.com/package/dom-serializer/

版本：3\.1\.1
npm 元数据更新时间：2026-05-02T11:26:46.768Z
中文译文更新时间：2026-11-05T14:41:22.010Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/dom-serializer
原文对照：https://npmcn.com/package/dom-serializer/?lang=original
项目主页：https://github.com/cheeriojs/dom-serializer#readme
源码仓库：https://github.com/cheeriojs/dom-serializer

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

- 包体积（解压后）：38.2 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.19\.0
- 运行依赖：3 个
- 首次发布：2014-05-20T13:20:43.000Z
- 最新版本发布：2026-05-02T11:26:46.442Z
- 近 30 天下载量：472718164（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 3 个）

## 中文简介

将 DOM 节点转换为字符串

## 安装

```sh
npm install dom-serializer
```

也可以使用：`pnpm add dom-serializer`、`yarn add dom-serializer`、`bun add dom-serializer`

## README

# dom 序列器 [![Node.js CI](https://github.com/cheeriojs/dom-serializer/actions/workflows/nodejs-test.yml/badge.svg)](https://github.com/cheeriojs/dom-serializer/actions/workflows/nodejs-test.yml)

显示 a [多姆汉德勒](https://github.com/fb55/domhandler) DOM节点或多姆汉德勒 DOM节点到字符串的阵列.

```js
import render from "dom-serializer";

// OR

const render = require("dom-serializer").default;
```

# API 密码

## `render`

▸ **提交**(单位:千美元)`node`: 节点 . , `options?`数字 : [_选项_](https://npmcn.com/package/dom-serializer/#readme-Options): _字符串_

将 DOM 节点或 DOM 节点数组渲染为字符串 .

可以认为相当于 `outerHTML` 的节点.

#### 参数:

| 名称 | 类型 | 默认值 | 说明 |
| --- | --- | :-- | :-- |
| `node` | 节点 QQ 节点 | \- 说吧 | 节点待发. |
| `options` | [_Dom 序列器选项_](https://npmcn.com/package/dom-serializer/#readme-Options) | {} | 更改序列化行为 |

**回返情况:** _字符串_

## 选项

### `encodeEntities`

二. 支助 `Optional` **编码实体**数字 : _布尔 “ utf8 ”_

在文本和属性值中保留 HTML 或 XML 中的编码字符.

若为 `xmlMode` 实值 `true` 数值不是 `'utf8'`,ASCII范围之外的字符也会被编码.

> **警卫:** 设为 `false` 禁用编码 `<`, (中文(简体) ), `>`,以及 `&` 在文本和属性值中。 这是为DOM处理的往返案件准备的 `decodeEntities: false`,因此标记字符仅作为实体引用存在。 如果 DOM 包含原始标记字符(例如,从默认解码的剖析,或从程序操作中),它们就会被字面地释放——除非您自己已经验证了 DOM ,否则不要使用不可信输入的这个选项.

**`default`** `decodeEntities`

* * *

### `decodeEntities`

二. 支助 `Optional` **解码实体**数字 : _布尔_

默认 `encodeEntities`。命名是为了匹配同名的解析器选项,这样就可以通过解析和序列化对单个选项对象进行线程处理。 尽管有名字, 在序列器上, 此选项可控 _编码_ - 设为 `false` 带有与 `encodeEntities: false`。 。 。 .

**`default`** 真实

* * *

### `emptyAttrs`

二. 支助 `Optional` **空自动**数字 : _布尔_

打印一个空属性的值 .

**`default`** xml 模式

**`example`** 与 `emptyAttrs: false`数字 : `<input checked>`

**`example`** 与 `emptyAttrs: true`数字 : `<input checked="">`

* * *

### `selfClosingTags`

二. 支助 `Optional` **自关闭标签**数字 : _布尔_

为没有内容的标签打印自闭标签. 若为 `xmlMode` 设定, 此 将适用于所有标记。 否则, 只有定义为自闭的标签 在 HTML 规格中,将按此打印.

**`default`** xml 模式

**`example`** 与 `selfClosingTags: false`数字 : `<foo></foo><br></br>`

**`example`** 与 `xmlMode: true` 财务报告和审定财务报表 `selfClosingTags: true`数字 : `<foo/><br/>`

**`example`** 与 `xmlMode: false` 财务报告和审定财务报表 `selfClosingTags: true`数字 : `<foo></foo><br />`

* * *

### `xmlMode`

二. 支助 `Optional` **xml 模式**数字 : _布尔_ | _"外国"_

将输入作为 XML 文档; 启用 `emptyAttrs` 财务报告和审定财务报表 `selfClosingTags` 选项.

如果值是 `"foreign"`,它会尝试纠正混合大小写属性名称.

**`default`** 虚假

* * *

## 生态系统

| 名称 | 说明 |
| --- | --- |
| [htmlparser2 软件](https://github.com/fb55/htmlparser2) | 快速原谅 HTML/ XML 解析器( F) |
| [多姆汉德勒](https://github.com/fb55/domhandler) | 将文档变成 DOM 的 htmlparser2 处理器 |
| [多姆蒂尔](https://github.com/fb55/domutils) | 与多曼德勒DOM合作的水电费 |
| [cs- 选择](https://github.com/fb55/css-select) | CSS 选择器引擎, 兼容 Domhandler 的 DOM |
| [欢呼声](https://github.com/cheeriojs/cheerio) | 多曼德勒的DOM 查询 API |
| [dom 序列器](https://github.com/cheeriojs/dom-serializer) | 多姆汉德勒DOM的序列器 |

* * *

麻省理工学院

## 常见问题

### dom-serializer 是什么？

将 DOM 节点转换为字符串

### 如何安装 dom-serializer？

在项目目录运行 npm install dom-serializer，或使用 pnpm add / yarn add / bun add。

### dom-serializer 支持 TypeScript 吗？

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

### dom-serializer 支持 ESM 还是 CommonJS？

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

### dom-serializer 需要什么版本的 Node\.js？

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

### dom-serializer 可以商用吗？

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

### dom-serializer 的下载量有多少？

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

### dom-serializer 还在维护吗？

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