# @telorun/sdk 中文文档

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

版本：0\.127\.0
npm 元数据更新时间：2026-11-02T15:35:09.880Z
中文译文更新时间：2026-11-02T16:11:38.476Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.1 MB，359 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-02-17T18:23:13.981Z
- 最新版本发布：2026-11-02T15:35:09.721Z
- 已发布版本数：105（近 12 个月 105 个）

## 中文简介

Telo SDK - Telo模块作者的公共API。

## 安装

```sh
npm install @telorun/sdk
```

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

## README

# Telo SDK (Node.js)

Node.js SDK为Telo模块提供了创作界面。它定义了模块用来插入内核的共享契约（类型和生命周期接口），因此模块代码在各个实现之间保持一致。

## 它提供了什么

-   **模块接口** 用于注册资源和处理执行。
-   **上下文类型** 用于访问内核、注册表和事件。
-   **共享基元** Telo模块和工具使用的。

## 何时使用它

在构建或扩展Telo模块时使用SDK。它不是内核本身; 它是保持模块行为一致和可预测的契约层。

## 错误

Telo区分了两种类型的失败 `Invocable` / `Runnable`：

-   **操作故障** ——纯 `Error` 或者 `RuntimeError` 投掷。传播到内核的基础设施层 (HTTP → Fastify 5xx，序列 → 冒泡)。这些表示bug或环境故障。
-   **域失败** - - - - - - `InvokeError` 投掷。邀请人公共合同的一部分。上的路由处理程序匹配 `error.code` 通过 `catches:` 条目;序列处理它们 `try`/`catch`.

```ts
import { InvokeError, isInvokeError } from "@telorun/sdk";

// In a controller:
throw new InvokeError("UNAUTHORIZED", "Token missing or invalid", {
  reason: "expired",
});

// Anywhere a thrown value crosses a boundary:
if (isInvokeError(err)) {
  // err.code, err.message, err.data
}
```

使用 `isInvokeError(err)` 为了识别——它是双领域安全的（幸免于pnpm提升拆分，注册表加载模块带有自己的SDK副本，以及未来的沙盒隔离）。 `instanceof InvokeError` 跨包边界不可靠。

抛出的控制器 `InvokeError` **必须** 声明它们的代码 `Telo.Definition`：

```yaml
kind: Telo.Definition
metadata: { name: VerifyToken }
capability: Telo.Invocable
throws:
  codes:
    UNAUTHORIZED: { description: Missing or invalid token. }
    EXPIRED:
      description: Token is past its expires_at.
      data:
        type: object
        properties:
          expiredAt: { type: string, format: date-time }
        required: [expiredAt]
```

未声明的代码发出 `${kind}.${name}.InvokeRejected.Undeclared` 可观察性事件-分析器静态捕获这些事件。

传播而不是产生代码的作曲家可以声明：

```yaml
throws:
  inherit: true   # union of everything I call (requires x-telo-step-context)
  # or
  passthrough: true   # union is whatever my inputs.code resolves to (Run.Throw-style)
```

`inherit` 由分析器的数据流传递驱动 `x-telo-step-context` 数组; 未来的作曲家通过声明注释和 `inherit: true`． 看到 [模块/跑步/ docs / structured-errors.md](https://github.com/telorun/telo/blob/main/modules/run/docs/structured-errors.md) 对于端到端流。

## 常见问题

### @telorun/sdk 是什么？

Telo SDK - Telo模块作者的公共API。

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

在项目目录运行 npm install @telorun/sdk，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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