# @haklex/rich-litexml 中文文档

规范地址：https://npmcn.com/package/%40haklex/rich-litexml/

版本：0\.66\.0
npm 元数据更新时间：2026-11-15T13:29:59.802Z
中文译文更新时间：2026-11-17T06:31:26.636Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：118 kB，40 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2026-03-30T18:41:35.558Z
- 最新版本发布：2026-11-15T13:29:59.461Z
- 近 30 天下载量：15689（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：152（近 12 个月 152 个）

## 中文简介

双向语法序列化 带插件注册的节点 <- > XML 转换

## 安装

```sh
npm install @haklex/rich-litexml
```

也可以使用：`pnpm add @haklex/rich-litexml`、`yarn add @haklex/rich-litexml`、`bun add @haklex/rich-litexml`

## README

# @haklex/ rich- litexml

用于方便 LLM 文档 I/O 的双向 Lexical 编辑器状态 XML 序列化。 转换 Lexical `SerializedEditorState` 改为紧凑的,具有符号效率的XML格式,并再次返回——使AI代理能够以最小的符号间接费用来读取和写入结构化的丰富文本文档.

## 安装

```bash
pnpm add @haklex/rich-litexml
```

## 同伴依赖关系

| 软件包 | 版本 |
| --- | --- |
| `lexical` | `^0.45.0` |

## 使用量

### 将编辑器状态序列化为 XML

```ts
import { serializeToXml } from '@haklex/rich-litexml';

const xml = serializeToXml(serializedEditorState);
// '<root><p>Hello <strong>world</strong></p><img src="..." /></root>'
```

### 将 XML 切换为编辑器状态

```ts
import { deserializeFromXml } from '@haklex/rich-litexml';

const editorState = deserializeFromXml(xmlString);
```

### 注册自定义节点类型

```ts
import { LitexmlRegistry } from '@haklex/rich-litexml';
import { registerBuiltinReaders, registerCustomReaders } from '@haklex/rich-litexml';
import { registerBuiltinWriters, registerCustomWriters } from '@haklex/rich-litexml';

const registry = new LitexmlRegistry();
registerBuiltinReaders(registry);
registerBuiltinWriters(registry);

// Add custom node readers/writers
registerCustomReaders(registry, [myReader]);
registerCustomWriters(registry, [myWriter]);
```

## 出口

### 序列化

| 导出 | 说明 |
| --- | --- |
| `serializeToXml(state, options?)` | 转换 `SerializedEditorState` 到 XML 字符串 |
| `serializeNodesToXml(nodes, options?)` | 将序列化节点数组转换为 XML |
| `deserializeFromXml(xml)` | 将 XML 字符串转换为 `SerializedEditorState` |
| `deserializeNodesFromXml(xml)` | 将 XML 字符串转换为序列化节点数组 |

### 书记官处

| 导出 | 说明 |
| --- | --- |
| `LitexmlRegistry` | 用于自定义节点阅读器/写入器的插件注册类 |
| `createDefaultRegistry()` | 创建一个预先使用内建内容的登记册 |
| `registerBuiltinReaders(registry)` | XML – 节点读取器内置的注册 |
| `registerBuiltinWriters(registry)` | 内置节点的注册 ~ XML 写入器 |
| `registerCustomReaders(registry, readers)` | 注册自定义阅读器 |
| `registerCustomWriters(registry, writers)` | 注册自定义作者 |

### 类型

| 导出 | 说明 |
| --- | --- |
| `XmlSerializerOptions` | XML 序列化选项 |
| `LitexmlNodeReader` | XML — 节点转换的读取器接口 |
| `LitexmlNodeWriter` | 节点- XML 转换的 Writer 接口 |
| `XmlNodeData`, (中文(简体) ), `XmlNodeElement` | XML AT 类型 |
| `XmlRenderOptions` | XML 输出的渲染样式选项 |

### 子路径导出

| 导入路径 | 说明 |
| --- | --- |
| `@haklex/rich-litexml` | 完全导出(浏览器或节点.js,自动选择) |

软件包在浏览器和 Node.js 入口之间自动选择: Node.js 使用 `linkedom` hTML 解析,而浏览器条目使用本地 `DOMParser`。 。 。 .

* * *

> **说明:** LiteXML基于XML,而不是自定义的DSL. 紧凑的标签词汇将 LLM 消耗的符号计数最小化 。 关于AI代理集成,参见 `@haklex/rich-agent-core`。 。 。 .

## 哈克历克的一部分

此软件包是 [哈克历](https://npmcn.com/package/README.md) 丰富的编辑生态系统.

## 许可证

麻省理工学院

## 常见问题

### @haklex/rich-litexml 是什么？

双向语法序列化 带插件注册的节点 \<- \> XML 转换

### 如何安装 @haklex/rich-litexml？

在项目目录运行 npm install @haklex/rich-litexml，或使用 pnpm add / yarn add / bun add。

### @haklex/rich-litexml 支持 TypeScript 吗？

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

### @haklex/rich-litexml 支持 ESM 还是 CommonJS？

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

### @haklex/rich-litexml 可以商用吗？

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

### @haklex/rich-litexml 的下载量有多少？

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

### @haklex/rich-litexml 还在维护吗？

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

