# @cumulus/checksum 中文文档

规范地址：https://npmcn.com/package/%40cumulus/checksum/

版本：22\.5\.0
npm 元数据更新时间：2026-11-05T20:58:18.894Z
中文译文更新时间：2026-11-11T04:42:46.232Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cumulus/checksum
原文对照：https://npmcn.com/package/%40cumulus/checksum/?lang=original
项目主页：https://github.com/nasa/cumulus/tree/master/packages/checksum/README.md
源码仓库：https://github.com/nasa/cumulus

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

- 包体积（解压后）：20.2 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^22\.23\.4
- 运行依赖：1 个
- 首次发布：2019-02-26T19:51:34.022Z
- 最新版本发布：2026-11-05T20:58:18.670Z
- 近 30 天下载量：5304（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：205（近 12 个月 36 个）

## 中文简介

Cumulus 校验和公用事业

## 安装

```sh
npm install @cumulus/checksum
```

也可以使用：`pnpm add @cumulus/checksum`、`yarn add @cumulus/checksum`、`bun add @cumulus/checksum`

## README

# @ cummulus/ checksum

## 校对和

这个 `@cumulus/checksum` 库提供 Cumulus 使用的校验和功能 软件包和任务。 目前所支持的输入包括文件流,以及 支持的校验和算法包括 `cksum` 和可用的算法 页:1 `crypto` 软件包,如文档 [这里](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options)。 。 。 .

## 使用量

```js
const fs = require('fs');
const { generateChecksumFromStream } = require('@cumulus/checksum');

const stream = fs.createReadStream('myDataFile.hdf');
const myCksum = generateChecksumFromStream('cksum', stream);
```

## API 密码

## 校验和

-   [校验和](https://npmcn.com/package/%40cumulus/checksum/#readme-module_checksum)
    -   [.generate Checksum from Stream(算法,流,\[可选 )](https://npmcn.com/package/%40cumulus/checksum/#readme-module_checksum.generateChecksumFromStream) ⇒ `Promise.<(number|string)>`
    -   [.validate Checksum From Stream(算法,流法,预期Sum,\[选项\])](https://npmcn.com/package/%40cumulus/checksum/#readme-module_checksum.validateChecksumFromStream) ⇒ `Promise.<boolean>`

### checksum.generate 从Stream(算法,流,\[可选 )\\\\\\x `Promise.<(number|string)>`

从可读流创建文件校验和

**仁爱**:静态方法 [`checksum`](https://npmcn.com/package/%40cumulus/checksum/#readme-module_checksum) **回返**数字 : `Promise.<(number|string)>` - 文件校验和

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 算法 | `string` | 校验和算法类型 |
| 流线 | `stream.Readable` | 可读文件流 |
| \[可选 | `Object` | 校验和选项,参见 `crypto.createHash()` |

### checksum.validate Checksum From Stream(算法,流出,预期Sum,\[可选 ) QQ `Promise.<boolean>`

对照计算出的校验和验证预期核对和

**仁爱**:静态方法 [`checksum`](https://npmcn.com/package/%40cumulus/checksum/#readme-module_checksum) **回返**数字 : `Promise.<boolean>` - 是否预期Sum QQ计算Sum

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 算法 | `string` | 校验和算法 |
| 流线 | `stream.Readable` | 可读文件流 |
| 预期中 | `number` | `string` | 检查和 |
| \[可选 | `Object` | 校验和选项 |

## 关于 Cumulus

Cumulus是一个以云为基础的数据摄取、存档、分发和管理 美国航天局未来地球科学数据流的原型.

[Cumulus 文档](https://nasa.github.io/cumulus)

* * *

自动使用 `npm run build-docs`

## 常见问题

### @cumulus/checksum 是什么？

Cumulus 校验和公用事业

### 如何安装 @cumulus/checksum？

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

### @cumulus/checksum 支持 TypeScript 吗？

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

### @cumulus/checksum 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cumulus/checksum 需要什么版本的 Node\.js？

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

### @cumulus/checksum 可以商用吗？

@cumulus/checksum 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cumulus/checksum 的下载量有多少？

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

### @cumulus/checksum 还在维护吗？

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