# @grammyjs/router 中文文档

规范地址：https://npmcn.com/package/%40grammyjs/router/

版本：2\.0\.0
npm 元数据更新时间：2025-03-01T13:34:14.980Z
中文译文更新时间：2026-11-16T22:05:47.947Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40grammyjs/router
原文对照：https://npmcn.com/package/%40grammyjs/router/?lang=original
项目主页：https://grammy.dev/plugins/router.html
源码仓库：https://github.com/grammyjs/router

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

- 包体积（解压后）：9.8 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^12\.20\.0 \|\| \>=14\.13\.1
- 运行依赖：0 个
- peer 依赖：grammy ^1\.0\.0
- 首次发布：2021-04-25T13:56:06.352Z
- 最新版本发布：2022-05-25T13:14:54.936Z
- 近 30 天下载量：15632（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

GrammY 的路由器中间软件

## 安装

```sh
npm install @grammyjs/router
```

也可以使用：`pnpm add @grammyjs/router`、`yarn add @grammyjs/router`、`bun add @grammyjs/router`

## README

# GrammY 的路由器中间软件

检查出来 [正式文件](https://grammy.dev/plugins/router.html) 用于此插件.

## 快速启动

一个路由器允许您指定一些中间软件,每个中间软件由一个字符串键识别. 然后,您可以通过一个路由函数,根据哪个中间软件通过返回一个密钥来选择的上下文来决定.

```ts
const router = new Router(ctx => {
  // determine route to pick here
  return 'key'
})

router.route('key',       ctx => { ... })
router.route('other-key', ctx => { ... })
router.otherwise(ctx => { ... }) // called if no route matches
bot.use(router)
```

如果你使用一个 [自定义上下文类型](https://grammy.dev/guide/context.html#customizing-the-context-object) 对于你的机器人, 你需要通过它 当建造 `Router` 也一样.

```ts
const router = new Router<MyContext>(ctx => { ... })
```

## 常见问题

### @grammyjs/router 是什么？

GrammY 的路由器中间软件

### 如何安装 @grammyjs/router？

在项目目录运行 npm install @grammyjs/router，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：grammy（^1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @grammyjs/router 支持 TypeScript 吗？

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

### @grammyjs/router 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @grammyjs/router 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^12\.20\.0 \|\| \>=14\.13\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @grammyjs/router 可以商用吗？

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

### @grammyjs/router 的下载量有多少？

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

### @grammyjs/router 还在维护吗？

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

