@byok-sdk/cloud-do

中文文档
0.40.0发布于 2026/11/08MITTypeScriptES Module近 30 天下载 4498

Cloudflare 持久对象会话主机,用于本地 pi可持久存储和执行

中文使用文档
文档目录5 节
  1. 安装和子类
  2. 身份和打电话者的访问
  3. 平台密钥和执行
  4. 储存和公共类型
  5. 包检查

@ byok- sdk/ cloud- do

此软件包在一个 Cloudflare 持久对象中主持一个可持久会话 . 它提供本地的 SQLite 存储器,内置工具, 提醒和收件箱处理, 使用限制 结算钩 以及记录.

目前稳定释放量为0.39.0,在九包释放装置中, 发表于 npm latest。从0.28.2起,密钥带有相同的版本。 时间 登记号2026-11-06(UTC) latest 全部九项 软件包。 见 发布注释。 。 。 . 较早的稳定释放为0.38.0和0.37.0 (公布于2026-11-04), 协调世界时,0.36.0 (协调世界时2026-11-03年出版),0.35.0 和0.34.0 (发表于2026-11-02, 世界协调时,0.33.0 和0.32.0(世界协调时2026-11-01年出版),0.31.0 (世界协调世界时2026-10-29年出版),0.30.2 (世界协调世界时2026-10-26年出版),0.30.1和0.30.0(世界协调世界时2026-10-24年出版), 0.29.0 (世界协调时2026-10-23年出版),0.28.3和0.28.2 (出版) 2026-10-22, UTC),0.28.1 / 键0.13.1 (公布于2026-10-21, UTC)并 0.28.0 / 键 0.13.0(世界协调时2026-10-20年公布);见 0.38.0 释放说明,则 0.37.0 发布说明,则 0.36.0 释放说明,则 0.35.0 释放说明,则 0.34.0 释放说明,则 0.33.0 释放说明,则 0.32.0 发布说明,则 0.31.0 释放说明,则 0.30.2 释放说明,则 0.30.1 释放说明,则 0.30.0 释放说明,则 0.29.0 释放说明,则 0.28.3 释放说明,则 0.28.2 释放说明,则 0.28.1 释放说明 编辑 0.28.0 释放说明。 。 。 .

他们之前的稳定放出为0.27.0,有键0.12. 完整的登记册 复读和孤立安装通过。 见 出版记录。 。 。 . 这个 rc 通道仍为0.27.0-rc.2/键为0.12.0-rc.2. 见 发布注释 用于主机升级 步骤。 主机接收(# 195)仍然单独开放.

这个 latest 0.27.0之前的释放为0.26.1,在9个包装的释放装置中 2026-10-12年通过了登记回放和单独安装. 见 出版记录。 。 。 . 较早的稳定释放量为0.26.0/键0.11.0 出版记录 仍然是历史. 较早出版的0.26.0-rc.4. (见 rc 4. 出版记录(中文(简体) ) 改为0.27.0-rc.2;0.26.0-rc.1至rc.3被取代。 见 发布注释。 。 。 . 现场主机接收仍然分开. 该套件需要节点24.22.1或后期来构建工具.

安装和子类

以下安装示例命名 0: 40.0 源候选人,等待发布. 使用已安装的软件包来验证消费者路径.

npm install @byok-sdk/[email protected]
npm install --save-dev @cloudflare/workers-types

一揽子措施是无害环境管理。 其根入入入入云花:工人. 在工人中运行它。 它不能在一个节点进程中加载 .

import { AgentDO, getAgentObject, getSessionObject } from '@byok-sdk/cloud-do';

export class ProductAgentDO extends AgentDO {
  protected instructions(): string {
    return 'Use the configured platform tools.';
  }
}

export default {
  fetch(): Response {
    return new Response('Not found', { status: 404 });
  },
};

在 wrangler.jsonc 中配置子类绑定和 SQLite 迁移 :

{
  "name": "product-agent",
  "main": "src/index.ts",
  "compatibility_date": "2026-08-18",
  "compatibility_flags": ["no_nodejs_compat", "no_nodejs_compat_v2"],
  "durable_objects": {
    "bindings": [{ "name": "AGENTS", "class_name": "ProductAgentDO" }]
  },
  "migrations": [
    { "tag": "v1", "new_sqlite_classes": ["ProductAgentDO"] }
  ]
}

消费者需要@cloudflare/工人类型来解决环境工人的问题 模块和持久对象类型。 使用ES2022和邦德勒模块分辨率. 已安装的包装烟雾使用跳过LibCheck:真实,就像SDK一样. 在测试配置中节点相容性关闭 。 一个消费者与其他人 旗帜必须验证其完整的“工人”图表.

身份和打电话者的访问

该平台必须授权房客、工作空间、代理和会议之前 它叫“会议目标”。 必须批准三个特工的身份 字段前的“代理对象”().

名称路由存储. 他们不授权打电话的人。 用户名 SHA -256 超过JSON的身份Tuples。 一个会话拥有一个名为持久对象的会话. 公共HTTP的路由和呼叫器访问检查属于消费者. 默认工人返回 HTTP 404.

平台密钥和执行

将 AIPHABEE ZAI API KEY 和 AIPHABEE DEEPSEEK API KEY 设定为工人的秘密 用于您平台使用的配置文件。 每个环境都有自己的秘密 和持久对象命名空间。 永远不要将密钥值放入源或请求数据.

支持的配置文件为 zai openai 和 deepseek direct. 模型 URL 和模型名称在此包中固定。 云执行使用平台键. 本地 BYOK 密钥不输入此运行时间 .

有# 654封装有效载荷的任务 sealing 不得进入此运行时间 。 这个 使用平台键运行模型,从而读取指令和 输出为正文。 见 协议§2.5。 。 。 .

配置会话并在工具执行前提供调度器 . 该子类可以提供指令,创建Dispatcher,承认Wake, 更新、安顿、调试和调试. 该平台拥有应享权利检查、账单和外部结算. 在结算钩之前有一个终端运行。 和解失败已重审 通过持久对象提醒。 消费者必须使结算具有一能性.

供应商在进入耐用存储之前的运输守护文本. 密钥仅在认证信头中使用 。 运输拒绝重定向. 警卫检查确切的密钥和定义的编码. 它无法检测到每一个 相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相相去相去相去相去相去相去相去相去相相去相去相去相去相相去相去相去相去相去相去相去相去相去相相去相去相去相去相去相去相相相去相去相 不要把它当作呼叫者的授权.

储存和公共类型

持久对象SqliteDatabase 适应持久对象SQLite连接. 本地结构工厂类型 (地点:持久目标集) 我保证. 存储是pi-dudable的本土界面. 软件包不导入客户端 源或密钥类型。 它的3个运行时间的依赖是可活性,可活性,可活性, 和和弦,每个被钉到1.5.0.

持久对象拥有物理连接 。 关闭适配器 无效适配器。 它不关闭持久对象数据库 .

这跟随同步适配器在 云浮剂 d6656161。 。 。 . 当前上游使用不同的同步pi合同. 平起地平线 1.5.0 自动调用,所以 transactionSync() 无法托管其交易召回. Cloudflare 文档 同步 SQL 交易 SQLite 存储 API。 。 。 .

RunRow和InboxRow一样公开. 它们包括内部状态, 修订、接纳、结算、使用和文本处理字段。 API (英语) 金锁这些类型。 稍后的断开类型切换需要 MINOR 释放 根据SDK的1.0前政策.

包检查

库会建立 dimits/index.js 和本地声明关闭. 检查拒绝丢失或逃脱的申报路径和未申报 外部类型进口。 入境依赖合同执行内在运行时间政策。 一个单独的Wrangler干线 差劲的工人 工人输出不在 npm 包中 .

发布验证在临时消费者中安装了真焦油球. 它输入子类, 捆绑它与Wrangler, 运行它的钩, 持久对象 RPC, 身份帮助器, 以及 SQLite 适配器, 以真实工作方式使用 . 相同的烟雾在Linux,macOS,和Windows的放行包工作中运行.

运行时间依赖性和规模预算: 入职扶养合同。 。 。 .

版本与发布记录

@byok-sdk/cloud-do 共发布 31 个版本,首次发布于 2026/10/07;过去 12 个月发布了 31 个版本。

版本发布日期距今
0.40.0latest2026/11/08今天
0.39.02026/11/072 天前
0.38.02026/11/054 天前
0.37.02026/11/044 天前
0.36.02026/11/035 天前
0.35.02026/11/026 天前

其他发布通道:rc → 0.27.0-rc.2。

关于 @byok-sdk/cloud-do 的常见问题

@byok-sdk/cloud-do 是什么?

Cloudflare 持久对象会话主机,用于本地 pi可持久存储和执行

如何安装 @byok-sdk/cloud-do?

在项目目录运行 npm install @byok-sdk/cloud-do,或使用 pnpm add / yarn add / bun add。

@byok-sdk/cloud-do 支持 TypeScript 吗?

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

@byok-sdk/cloud-do 支持 ESM 还是 CommonJS?

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

@byok-sdk/cloud-do 需要什么版本的 Node.js?

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

@byok-sdk/cloud-do 可以商用吗?

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

@byok-sdk/cloud-do 的下载量有多少?

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

@byok-sdk/cloud-do 还在维护吗?

最新版本 0.40.0 发布于 2026/11/08(今天);至今共发布 31 个版本,其中过去 12 个月发布了 31 个;首次发布于 2026/10/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。