# @canvas-js/okra 中文文档

规范地址：https://npmcn.com/package/%40canvas-js/okra/

版本：0\.4\.7
npm 元数据更新时间：2025-03-19T19:31:52.201Z
中文译文更新时间：2026-11-09T15:58:44.440Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：43.7 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2023-05-04T20:59:12.207Z
- 最新版本发布：2025-03-19T19:31:51.953Z
- 近 30 天下载量：2297（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

纯 JavaScript 中的 p2p merkle 索引

## 安装

```sh
npm install @canvas-js/okra
```

也可以使用：`pnpm add @canvas-js/okra`、`yarn add @canvas-js/okra`、`bun add @canvas-js/okra`

## README

# `@canvas-js/okra`

[![NPM version](https://img.shields.io/npm/v/@canvas-js/okra)](https://www.npmjs.com/package/@canvas-js/okra) ![TypeScript types](https://img.shields.io/npm/types/@canvas-js/okra)

## 安装

```
npm i @canvas-js/okra
```

## 使用量

```ts
import { sync } from "@canvas-js/okra"
import { MemoryTree } from "@canvas-js/okra-memory"

const source = await MemoryTree.open()
const target = await MemoryTree.open()

const hex = (hex: string) => Buffer.from(hex, "hex")

await source.set(hex("00"), hex("aa"))
await target.set(hex("00"), hex("aa"))

await source.set(hex("01"), hex("bb"))

await source.set(hex("02"), hex("cc"))
await target.set(hex("02"), hex("dd"))

async function collect<T>(iter: AsyncIterable<T>): Promise<T[]> {
    const values = []
    for await (const value of iter) {
        values.push(value)
    }
    return values
}

const delta = await collect(sync(source, target))
console.log(delta)
// [
//   { key: <Buffer 01>, source: <Buffer bb>, target: null },
//   { key: <Buffer 02>, source: <Buffer cc>, target: <Buffer dd> }
// ]
```

## 常见问题

### @canvas-js/okra 是什么？

纯 JavaScript 中的 p2p merkle 索引

### 如何安装 @canvas-js/okra？

在项目目录运行 npm install @canvas-js/okra，或使用 pnpm add / yarn add / bun add。

### @canvas-js/okra 支持 TypeScript 吗？

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

### @canvas-js/okra 支持 ESM 还是 CommonJS？

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

### @canvas-js/okra 可以商用吗？

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

### @canvas-js/okra 的下载量有多少？

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

### @canvas-js/okra 还在维护吗？

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