@grammyjs/router

中文文档
2.0.0发布于 2022/05/25MITTypeScriptCommonJS零依赖近 30 天下载 1.6万

Router middleware for grammY

原始使用文档

Router middleware for grammY

Check out the official documentation for this plugin.

Quickstart

A router lets you specify a number of middlewares, each of them identified by a string key. You can then pass a routing function that decides based on the context which middleware to choose by returning one of the keys.

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)

If you use a custom context type for your bot, you need to pass it when constructing the Router instance, too.

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

版本与发布记录

@grammyjs/router 共发布 11 个版本,首次发布于 2021/04/25;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.0latest2022/05/254 年前
1.1.12021/09/065 年前
1.1.02021/08/305 年前
1.0.72021/08/305 年前
1.0.62021/05/145 年前
1.0.52021/05/065 年前

关于 @grammyjs/router 的常见问题

@grammyjs/router 是什么?

Router middleware for 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 和提交记录判断。