# @hy-sde-org/dsh-zstd-frame 中文文档

规范地址：https://npmcn.com/package/%40hy-sde-org/dsh-zstd-frame/

版本：0\.2\.1-rc\.5
npm 元数据更新时间：2026-11-01T04:21:03.144Z
中文译文更新时间：2026-11-01T10:02:19.525Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40hy-sde-org/dsh-zstd-frame
原文对照：https://npmcn.com/package/%40hy-sde-org/dsh-zstd-frame/?lang=original
项目主页：https://github.com/hy-sde/dsh-zstd-frame#readme
源码仓库：https://github.com/hy-sde/dsh-zstd-frame

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

- 包体积（解压后）：38.5 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.19\.0
- 运行依赖：0 个
- peer 依赖：@deepseek-ai/cordis ~4\.0\.5
- 首次发布：2026-08-26T03:24:52.349Z
- 最新版本发布：2026-11-01T04:21:02.963Z
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

由DeepSeek Harness会话持久性后端和项目内存库共享的标准帧原语（扫描/压缩/解压/多帧解码器），作为一个独立的npm包。

## 安装

```sh
npm install @hy-sde-org/dsh-zstd-frame
```

也可以使用：`pnpm add @hy-sde-org/dsh-zstd-frame`、`yarn add @hy-sde-org/dsh-zstd-frame`、`bun add @hy-sde-org/dsh-zstd-frame`

## README

# @hy-sde-org dsh-zstd-frame

由DeepSeek Harness会话共享的标准帧原语 持久性后端(`session.jsonl.zstd`)和项目记忆库 （`bank.jsonl.zstd`）. 两者都存储仅追加、校验和、每批zstd 帧;这个包拥有结构扫描，一次性压缩/ 解压缩API与校验和，扭转帧恢复，和可互换 多帧解码器，因此消费者永远不会重新实现帧布局或 节点私有解码器生命周期。

独立发布为 `@hy-sde-org/dsh-zstd-frame`;这镜子 `@deepseek-ai/dsh-zstd-frame` 在 [侧深seek-harness叉](https://github.com/hy-sde/deepseek-harness).

完全由 `node:zlib` -没有原生模块，工作在进程中。

## API

```ts
import {
  compressZstdFrame,
  decompressZstdFrame,
  decompressZstdFrameSync,
  decompressZstdPrefix,
  scanZstdFrames,
  createZstdFrameDecoder,
} from '@hy-sde-org/dsh-zstd-frame'
```

-   `scanZstdFrames(buffer, maxFrames?)` → `{ frames: ZstdFrameRange[], tornStart? }` - - - - - - 定位完整帧而不解压它们的块；内部的EOF 最后一帧返回其开始进行修复。
-   `compressZstdFrame(input)` -一个独立可解码，校验和帧。
-   `decompressZstdFrame(input, maxOutput?)` / `decompressZstdFrameSync(...)` - - - - - - 带有可选明文绑定的单帧解压缩。
-   `decompressZstdPrefix(input)` -恢复可用的明文 结构不完整的最终框架。
-   `createZstdFrameDecoder()` - - - - - - `NodePrivateZstdFrameDecoder` 当跑步时 节点形状是兼容的，否则 `PublicZstdFrameDecoder`;两者都实现了 常见的 `ZstdFrameDecoder` 接口(`decode(source, frames)` 发电机+ `close()`）。

## 已知的限制和延迟的工作

-   私有句柄解码器(`NodePrivateZstdFrameDecoder`)取决于 私人 `zlib._handle.writeSync` 这是公共Node API所没有的 文档;解码器特征探测在负载和回落到 one-shot-based `PublicZstdFrameDecoder` 当形状不相容时，那么 正确性从不依赖于私有内部。
-   无流增量压缩；每批写入整个帧。
-   只有 _校验和_ 框架是由 `compressZstdFrame` （`ZSTD_c_checksumFlag`), `decompressZstdPrefix` 故意抑制 最终帧/校验和完成-调用者必须建立撕裂边界 在使用它之前自己。

## 许可证

麻省理工学院。源自DeepSeek线束代码库；看到 `THIRD-PARTY-NOTICES.md` 出处。

## 常见问题

### @hy-sde-org/dsh-zstd-frame 是什么？

由DeepSeek Harness会话持久性后端和项目内存库共享的标准帧原语（扫描/压缩/解压/多帧解码器），作为一个独立的npm包。

### 如何安装 @hy-sde-org/dsh-zstd-frame？

在项目目录运行 npm install @hy-sde-org/dsh-zstd-frame，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@deepseek-ai/cordis（~4\.0\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @hy-sde-org/dsh-zstd-frame 支持 TypeScript 吗？

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

### @hy-sde-org/dsh-zstd-frame 支持 ESM 还是 CommonJS？

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

### @hy-sde-org/dsh-zstd-frame 需要什么版本的 Node\.js？

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

### @hy-sde-org/dsh-zstd-frame 可以商用吗？

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

### @hy-sde-org/dsh-zstd-frame 还在维护吗？

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

