# @develit-io/backend-sdk 中文文档

规范地址：https://npmcn.com/package/%40develit-io/backend-sdk/

版本：12\.7\.2
npm 元数据更新时间：2026-11-05T09:52:00.948Z
中文译文更新时间：2026-11-12T02:41:27.599Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：183 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：zod ^4\.3\.6，hono ^4\.12\.7，drizzle-orm ^1\.0\.0-rc\.1，@sentry/cloudflare ^11\.9\.0，@develit-io/general-codes ^1\.19\.2
- 首次发布：2025-07-22T13:57:02.129Z
- 最新版本发布：2026-11-05T09:52:00.681Z
- 近 30 天下载量：3295（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：197（近 12 个月 104 个）

## 中文简介

调试后端 SDK

## 安装

```sh
npm install @develit-io/backend-sdk
```

也可以使用：`pnpm add @develit-io/backend-sdk`、`yarn add @develit-io/backend-sdk`、`bun add @develit-io/backend-sdk`

## README

# 调试后端 SDK

用于构建Cloudflare工人的TypeScript SDK,具有数据库集成,指令模式,以及自动审计记录等功能.

## 安装

```bash
bun add @develit-io/backend-sdk
```

## 核心特征

-   **工人框架**: 基于装饰器的动作 `@action()` 财务报告和审定财务报表 `@service()`
-   **数据库整合**: 内建 Drizzle ORM 与 `initializeDB()`
-   **命令模式**: 可重复使用,参数化的数据库操作
-   **原子审计记录**: 审计日志列入同一批数据库
-   **类型安全**: 全部类型脚本支持

## 快速启动

```typescript
@service('user-service')
export default class UserService extends develitWorker(WorkerEntrypoint<UserEnv>) {

  constructor(env: Env, ctx: ExecutionContext) {
    super(env, ctx)
    // Setup audit logging
    const auditWriter = createAuditLogWriter(tables.auditLog)
    this.initializeDB(env.USER_DB, tables, auditWriter)
    // Now available: this.db
  }

  @action('create-user')
  async createUser(input: CreateUserInput): Promise<IRPCResponse<CreateUserOutput>> {
    return this.handleAction(
      {data: input, schema: createUserInputSchema},
      {successMessage: 'User created successfully'},
      () => {
        await this.db.execute(createUserCommand(userData))
    })
  }
}
```

## 密钥导出

```typescript
// Core functionality
export { develitWorker, action, service } from '@develit-io/workers-sdk'
export { defineCommand, DatabaseTransaction, createAuditLogWriter } from '@develit-io/workers-sdk'

// Built-in worker properties after initializeDB():
// - this.db: DatabaseTransaction
```

## 实例

-   **[定义命令使用](https://npmcn.com/package/%40develit-io/backend-sdk/examples/define-command.md)** - 创建参数化命令
-   **[数据库交易使用](https://npmcn.com/package/%40develit-io/backend-sdk/examples/database-transaction.md)** - 交易和审计记录

## 所需资源

-   节点.js 22+
-   类型脚本 5.8.3+
-   云花板工人环境
-   Drizzle ORM 设置

## 许可证

ISC许可证 - 详情见pack.json.

## 常见问题

### @develit-io/backend-sdk 是什么？

调试后端 SDK

### 如何安装 @develit-io/backend-sdk？

在项目目录运行 npm install @develit-io/backend-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.3\.6）、hono（^4\.12\.7）、drizzle-orm（^1\.0\.0-rc\.1）、@develit-io/general-codes（^1\.19\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @develit-io/backend-sdk 支持 TypeScript 吗？

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

### @develit-io/backend-sdk 支持 ESM 还是 CommonJS？

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

### @develit-io/backend-sdk 可以商用吗？

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

### @develit-io/backend-sdk 的下载量有多少？

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

### @develit-io/backend-sdk 还在维护吗？

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