# @eraserlabs/protocol 中文文档

规范地址：https://npmcn.com/package/%40eraserlabs/protocol/

版本：0\.5\.2
npm 元数据更新时间：2026-11-11T18:25:29.697Z
中文译文更新时间：2026-11-13T20:24:32.476Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40eraserlabs/protocol
原文对照：https://npmcn.com/package/%40eraserlabs/protocol/?lang=original
项目主页：https://github.com/eraserlabs/eraser-diagrams
源码仓库：https://github.com/eraserlabs/eraser-diagrams

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

- 包体积（解压后）：35.6 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.23\.4 \|\| ^24\.22\.1 \|\| \>=26\.12\.1
- 运行依赖：0 个
- 首次发布：2026-08-19T03:41:35.542Z
- 最新版本发布：2026-11-11T18:25:29.328Z
- 近 30 天下载量：10913（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

参考 TypeScript 合同, schema 词汇表, 以及用于模型绘图协议(MDP)的机器可读计划.

## 安装

```sh
npm install @eraserlabs/protocol
```

也可以使用：`pnpm add @eraserlabs/protocol`、`yarn add @eraserlabs/protocol`、`bun add @eraserlabs/protocol`

## README

# @ eraserlabs/ protocol (英语)

## 导言

`@eraserlabs/protocol` 是模型绘图协议(MDP)的TypeScript和JSON Schema分布. MDP描述了图元素,它们的视觉模板,以及它们通过分辨率,测量,布局和渲染来传递的合同. 协议是词汇中立的;这个软件包是参考分布,以及 `@eraserlabs/diagrams` 上面有一个MDP简介.

软件包没有解析器,浏览器,布局,文件系统,或网络执行.

## 为什么

解析、渲染和布局需要共享文档和计划词汇。 把这些合同放在执行合同的包件中,将使每个消费者与Node、Chrimium或某个特定特征相配。 MDP将电线形状和说明保存在一个地方;执行和剖面可替换.

## 使用量

```ts
import type { ResolvedDocument } from '@eraserlabs/protocol';
import { entitySchema } from '@eraserlabs/protocol/schema';
```

| 导出 | 目录 |
| --- | --- |
| `@eraserlabs/protocol` | MDP标识、已解决的文件/模板/合同、语义DOM作用 |
| `@eraserlabs/protocol/schema` | JSON斯克马子集, `x-schema-kind` 编号 : `x-is-container` 以及财产说明、 善待者 |
| `@eraserlabs/protocol/schemas/document` | 基础作者文档 JSON Schema |
| `@eraserlabs/protocol/schemas/tag-schema` | 针对 MDP 0.1 子集的配置标签的Meta-schema |

作者类型脚本输入形状( S)`DiagramInput` (b) 与家庭有关的家庭 `@eraserlabs/resolve`,它拥有输入语法。 协议文本是 `SPEC.md`。 。 。 .

## 常见问题

### @eraserlabs/protocol 是什么？

参考 TypeScript 合同, schema 词汇表, 以及用于模型绘图协议\(MDP\)的机器可读计划\.

### 如何安装 @eraserlabs/protocol？

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

### @eraserlabs/protocol 支持 TypeScript 吗？

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

### @eraserlabs/protocol 支持 ESM 还是 CommonJS？

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

### @eraserlabs/protocol 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.23\.4 \|\| ^24\.22\.1 \|\| \>=26\.12\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @eraserlabs/protocol 可以商用吗？

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

### @eraserlabs/protocol 的下载量有多少？

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

### @eraserlabs/protocol 还在维护吗？

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