# @effect-ak/tg-bot-api 中文文档

规范地址：https://npmcn.com/package/%40effect-ak/tg-bot-api/

版本：1\.13\.0
npm 元数据更新时间：2026-11-13T15:18:46.078Z
中文译文更新时间：2026-11-13T23:09:03.801Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40effect-ak/tg-bot-api
原文对照：https://npmcn.com/package/%40effect-ak/tg-bot-api/?lang=original
项目主页：https://tg-bot-sdk.website/
源码仓库：https://github.com/kondaurovDev/tg-bot-sdk

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

- 包体积（解压后）：478 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-12-07T19:28:54.657Z
- 最新版本发布：2026-11-13T15:18:45.712Z
- 近 30 天下载量：2974（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

Telegram Bot Api 和Telegram Mini Apps 的脚本类型

## 安装

```sh
npm install @effect-ak/tg-bot-api
```

也可以使用：`pnpm add @effect-ak/tg-bot-api`、`yarn add @effect-ak/tg-bot-api`、`bun add @effect-ak/tg-bot-api`

## README

# @ effect- ak/ tg- bot- api

[![NPM Version](https://img.shields.io/npm/v/%40effect-ak%2Ftg-bot-api)](https://www.npmjs.com/package/@effect-ak/tg-bot-api) ![Telegram Bot API](https://img.shields.io/badge/BotApi-10.4-blue) ![Telegram WebApp](https://img.shields.io/badge/Telegram.WebApp-10.1-orange)

完整的TypeScript类型用于Telegram Bot API和Mini Apps,由官方文档自动生成.

## 安装

```bash
npm install @effect-ak/tg-bot-api
```

## 特征

-   **总是上到日期** - 产生自 [正式的电报文件](https://core.telegram.org/bots/api) 通过代码生成器
-   **WebApp 类型** - 类型 `Telegram.WebApp` 包含
-   **智能类型映射** —— 说 `Integer` → `number`, (中文(简体) ), `True` → `boolean`, enums 等 工会文字等.

## 导出什么

```typescript
import type {
  Api,
  Update,
  Message,
  CallbackQuery,
  InlineKeyboardMarkup,
  SendMessageInput,
  WebApp
} from "@effect-ak/tg-bot-api"

// Api — one method per Bot API method, snake_case, typed input → typed result
interface Api {
  send_message(_: SendMessageInput): Message
  answer_callback_query(_: AnswerCallbackQueryInput): boolean
  // … every Bot API method
}
// Every Bot API type as an interface (Update, Message, Chat, User, …)
// <Method>Input — parameter object of each method (SendMessageInput, EditMessageTextInput, …)
// WebApp, WebAppInitData, ThemeParams, … — Telegram.WebApp (Mini Apps) surface
// verifyLoginData(...) — validate Telegram Login Widget / Mini App init data hash
```

字段名称,可选性和描述从官方文件中逐字取出,所以任何你读到的 [https://core.telegram.org/bots/api (英语)](https://core.telegram.org/bots/api) 现适用. `InputFile` 参数额外接受 `{ file_content: Uint8Array, file_name: string }` (被客户端用于上传).

同一规格的机器可读版本与文件一起发布: [(原始内容存档于2013-10-10). bot-api.json](https://tg-bot-sdk.website/bot-api.json), (中文(简体) ), [小型应用程序](https://tg-bot-sdk.website/mini-app.json)。 。 。 .

## 文档

-   瓶型 API 类型 : **[tg-bot-sdk.website/api-types/bot-api](https://tg-bot-sdk.website/api-types/bot-api/)**,迷你Apps: 迷你Apps: 迷你Apps: [/ api- 类型/ 网络应用](https://tg-bot-sdk.website/api-types/webapp/)
-   参考,每方法/类型一页: [https://tg-bot-sdk.website/api/ 页面存档备份,存于互联网档案馆](https://tg-bot-sdk.website/api/)
-   发电机是如何工作的: [/api-types/how-it-works(英语:api-types/how-it-works) /api-types/how-it-works(英语:api-types-thow-it-works)) 单曲 单曲 单曲](https://tg-bot-sdk.website/api-types/how-it-works/)
-   对于 LLM/ 编码代理 : [https://tg-bot-sdk.website/llms.txt](https://tg-bot-sdk.website/llms.txt)

## 更新Telegram Bot API 类型

当新的Telegram Bot API版本发布时使用此清单.

### 项目背景

-   (原始内容存档于2019-10-12). Monorepo with pnpm workspaces.
-   `packages/api/` 包含官方Telegram Bot API HTML Docs自动生成的TypeScript类型.
-   代码刮出 [https://core.telegram.org/bots/api (英语)](https://core.telegram.org/bots/api) 财务报告和审定财务报表 [https://core.telegram.org/bots/webapps (中文(简体) )](https://core.telegram.org/bots/webapps)。 。 。 .
-   下载的 HTML 缓存于 `packages/api/input/api.html` 财务报告和审定财务报表 `packages/api/input/webapp.html`。 。 。 .
-   版本文件为 `packages/api/bot-api-version.json` 财务报告和审定财务报表 `packages/api/mini-app-version.json`。 。 。 .
-   存储在 `docs/src/data/bot-api-stats.json`。 。 。 .
-   徽章在 `readme.md` 财务报告和审定财务报表 `packages/api/readme.md`。 。 。 .

### 1\. 删除缓存的 HTML

删除两个已缓存文件, 因此代码源下载新文件 :

```bash
rm -f packages/api/input/api.html packages/api/input/webapp.html
```

### 2\. 运行代码源

```bash
cd packages/api && pnpm run gen
```

这将:

-   从Telegram下载新的 HTML .
-   分析并生成类型脚本类型 `src/specification/`。 。 。 .
-   自动更新版本文件和数据 .

### 3\. 检查变化

```bash
git diff --stat
```

看看这个:

-   `packages/api/bot-api-version.json` - 版本号码有变吗?
-   `packages/api/src/specification/types.ts` - 新的或更改的接口.
-   `packages/api/src/specification/api.ts` - 新的或改变的方法.
-   `docs/src/data/bot-api-stats.json` - 更新类型和方法.

### 4\. 分析变化日志

读取 `packages/api/input/api.html` 并搜索上方附近的更改日志部分。 查找最新版本条目并摘要 :

-   新增类型.
-   添加了新方法.
-   在现有类型上新建或已更改的字段.
-   任何中断的更改, 如已删除或更名的字段 .

### 5\. 核查一切工作

按顺序运行 :

```bash
pnpm build
pnpm typecheck
pnpm test
```

所有命令都必须以零出错的方式通过.

### 6\. 报告

输出摘要如下:

-   前一个版本 - > 新版本.
-   新类型和方法的数目.
-   主要变化,包括新类型、方法和字段.
-   构建、打字和测试状态.
-   提醒创建更改列表 。 一个小的更改器 `@effect-ak/tg-bot-api` 够了,因为 `fixed` 正在编辑 `.changeset/config.json` 三个包裹都会撞到一起.

## 许可证

麻省理工学院

## 常见问题

### @effect-ak/tg-bot-api 是什么？

Telegram Bot Api 和Telegram Mini Apps 的脚本类型

### 如何安装 @effect-ak/tg-bot-api？

在项目目录运行 npm install @effect-ak/tg-bot-api，或使用 pnpm add / yarn add / bun add。

### @effect-ak/tg-bot-api 支持 TypeScript 吗？

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

### @effect-ak/tg-bot-api 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @effect-ak/tg-bot-api 可以商用吗？

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

### @effect-ak/tg-bot-api 的下载量有多少？

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

### @effect-ak/tg-bot-api 还在维护吗？

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