# @dev\.fast/diffr 中文文档

规范地址：https://npmcn.com/package/%40dev.fast/diffr/

版本：0\.1\.23
npm 元数据更新时间：2026-10-30T21:14:56.985Z
中文译文更新时间：2026-11-12T12:44:44.500Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：31.1 kB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：zod ^4\.0\.0
- 首次发布：2026-09-21T21:56:47.053Z
- 最新版本发布：2026-10-30T21:14:56.683Z
- 近 30 天下载量：2478（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 22 个）

## 中文简介

diffr 的 NDJSON 线条合同, 验证器, 和 这个平台的 diffr 二进制

## 安装

```sh
npm install @dev.fast/diffr
```

也可以使用：`pnpm add @dev.fast/diffr`、`yarn add @dev.fast/diffr`、`bun add @dev.fast/diffr`

## README

# @dev.fast/diffr (英语)

Diffr 的 NDJSON 协议的 typeScript 类型和 zod 验证器, 加上 diffr 可执行文件 。 软件包版本与diffr发行相匹配.

```ts
import { decodeStructuralDiffEvent } from "@dev.fast/diffr";
const event = decodeStructuralDiffEvent(line);
```

`diffrBinaryPath()` 返回可执行文件 `@dev.fast/diffr-<platform>-<arch>` 为此机器安装的可选依赖 npm, 或 `undefined` 当没有 (Musl Linux、Windows arm64,或 `--omit=optional`平台:macOS arm64和x64, glibc Linux arm64 and x64, Windows x64. 互联网档案馆的存檔,存档日期2013-12-04.

## 电线变化

保持这些文件同步 :

| 文件(与 `diffr/` 在白板存储器中) | 检查 |
| --- | --- |
| `crates/diffr-core/src/protocol/mod.rs`, (中文(简体) ), `crates/diffr-core/src/pairing.rs`, (中文(简体) ), `diffr-ts/src/contract.ts` | 针对二进制的合同测试; Rust 版本检查 |
| `docs/streaming.md` | 对照电线格式进行审查 |
| `packages/viewer/src/protocol/wire.ts` (仅v3) | TUI 固定测试 |
| `../packages/review-protocol/package.json` 财务报告和审定财务报表 `../packages/review/package.json` | 精确的软件包版本针 |

## 释放

弹出 `diffr-ts/package.json` 与 `Cargo.toml`。发布工作流程公布 使用 npm 信任的发布,从标签中获取平台软件包和此软件包.

## 常见问题

### @dev\.fast/diffr 是什么？

diffr 的 NDJSON 线条合同, 验证器, 和 这个平台的 diffr 二进制

### 如何安装 @dev\.fast/diffr？

在项目目录运行 npm install @dev\.fast/diffr，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dev\.fast/diffr 支持 TypeScript 吗？

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

### @dev\.fast/diffr 支持 ESM 还是 CommonJS？

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

### @dev\.fast/diffr 需要什么版本的 Node\.js？

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

### @dev\.fast/diffr 可以商用吗？

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

### @dev\.fast/diffr 的下载量有多少？

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

### @dev\.fast/diffr 还在维护吗？

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