@canvas-js/okra

Install
npm i @canvas-js/okra
Usage
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 的常见问题
@canvas-js/okra 是什么?
A p2p merkle index in pure JavaScript
如何安装 @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 和提交记录判断。