# @backifydev/sdk 中文文档

规范地址：https://npmcn.com/package/%40backifydev/sdk/

版本：0\.2\.0
npm 元数据更新时间：2026-11-07T12:22:04.987Z
中文译文更新时间：2026-11-07T20:06:10.572Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40backifydev/sdk
原文对照：https://npmcn.com/package/%40backifydev/sdk/?lang=original
项目主页：https://docs.backify.dev/sdk
源码仓库：https://github.com/frejnorling/backify

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

- 包体积（解压后）：237 kB，78 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2026-10-01T08:41:05.929Z
- 最新版本发布：2026-11-07T12:22:04.815Z
- 近 30 天下载量：2735（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 19 个）

## 中文简介

SDK 独立应用程序平台

## 安装

```sh
npm install @backifydev/sdk
```

也可以使用：`pnpm add @backifydev/sdk`、`yarn add @backifydev/sdk`、`bun add @backifydev/sdk`

## README

# @ backifydev/ sdk (英语)

Backify应用程序宣布一个服务器输入,并传送一个带有网络,工人和迁移过程角色的图像. 导入服务器 API 从 `@backifydev/sdk/app`从 `@backifydev/sdk/config`和测试辅助者 `@backifydev/sdk/testing`。浏览器代码调用应用程序的 API `fetch`;数据库证书和工作量符号留在服务器上.

```ts
import { defineBackend, database, defineJob, schedule, z } from "@backifydev/sdk/app";
export const api = defineBackend();
api.get("/api/items", { auth: "user" }, async ({ user }) =>
  (await database().query("SELECT id, title FROM items WHERE owner_id = $1", [user.id])).rows);
export const cleanup = defineJob("cleanup", async () => {
  await database().query("DELETE FROM items WHERE archived AND created_at < now() - interval '30 days'");
});
schedule("nightly-cleanup", { cron: "0 3 * * *" }, cleanup);
```

在模块顶层宣布路径、任务、时间表和事件订阅。 每个路由默认为认证访问; 使用 `auth: "public"` 只是故意的,我说得没错 SDK验证已签名的网关身份,并在处理器运行前执行路由角色或权限. 处理器必须覆盖所有行和文件到经认证的用户或组织.

使用 `database()` 用于PostgreSQL, `transaction()` 对于原子写,和 `events.publish(name, payload, { client: tx })` 用于交易事件发件箱. `bucket(name)` 得到经纪人的短寿命范围存储证书. AI,邮件,管理HTTP和集成使用经纪人服务. `secret(name)` 财务报告和审定财务报表 `config(key)` 读取平台输入值.

创建工程 `backify new my-app --template web|api|worker`运行 `backify dev` 当地, `backify lock` 签订确定性释放合同 `backify check` 承诺之前。 本地开发使用真实的私人PostgreSQL和当地的经纪人;测试身份帮助者从不属于生产代码.

遗产根, `/server`, (中文(简体) ), `/local` 财务报告和审定财务报表 `/runtime` 已删除了进口的功能、浏览器直接数据库访问、氢氟烷烃捆绑和工作量包装。 见 [运行时间合同](https://npmcn.com/package/docs/architecture/app-runtime-contract.md) 财务报告和审定财务报表 [支出管理器](https://npmcn.com/package/examples/expense-manager/README.md)。 。 。 .

## 常见问题

### @backifydev/sdk 是什么？

SDK 独立应用程序平台

### 如何安装 @backifydev/sdk？

在项目目录运行 npm install @backifydev/sdk，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 backify-run，可以用 npx backify-run 直接运行。

### @backifydev/sdk 支持 TypeScript 吗？

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

### @backifydev/sdk 支持 ESM 还是 CommonJS？

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

### @backifydev/sdk 可以商用吗？

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

### @backifydev/sdk 的下载量有多少？

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

### @backifydev/sdk 还在维护吗？

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