调试后端 SDK
用于构建Cloudflare工人的TypeScript SDK,具有数据库集成,指令模式,以及自动审计记录等功能.
安装
bun add @develit-io/backend-sdk
核心特征
- 工人框架: 基于装饰器的动作
@action()财务报告和审定财务报表@service() - 数据库整合: 内建 Drizzle ORM 与
initializeDB() - 命令模式: 可重复使用,参数化的数据库操作
- 原子审计记录: 审计日志列入同一批数据库
- 类型安全: 全部类型脚本支持
快速启动
@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))
})
}
}
密钥导出
// 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
实例
所需资源
- 节点.js 22+
- 类型脚本 5.8.3+
- 云花板工人环境
- Drizzle ORM 设置
许可证
ISC许可证 - 详情见pack.json.