@grammyjs/transformer-throttler

中文文档
1.2.1发布于 2022/11/13MITTypeScriptCommonJS近 30 天下载 400.1万

格莱美变压器

中文使用文档
文档目录3 节
  1. 关于
  2. 配置
  3. 使用量

grammY Throttler (转换器)

旋转变压器 格莱姆Y 以 字体 搭建时 圆顶。 。 。 .

关于

这个节奏器旨在限制和排队向外的 Telegram API 调用以适应官方 Telegram API 费率限制。 。 。 .

配置

节流器接受以下形式的单个可选参数:

type ThrottlerOptions = {
  global?: Bottleneck.ConstructorOptions;     // For throttling all api calls
  group?: Bottleneck.ConstructorOptions;      // For throttling outgoing group messages
  out?: Bottleneck.ConstructorOptions;        // For throttling outgoing private messages
};

可用的对象属性完整列表 Bottleneck.ConstructorOptions 可见于 圆顶。 。 。 .

如果没有通过参数,所创建的节流器将使用默认配置设置,这种设置应当适合大多数使用的情况。 默认配置如下:

// Outgoing Global Throttler
const globalConfig = {
  reservoir: 30,                  // Number of new jobs that throttler will accept at start
  reservoirRefreshAmount: 30,     // Number of jobs that throttler will accept after refresh
  reservoirRefreshInterval: 1000, // Interval in milliseconds where reservoir will refresh
};

// Outgoing Group Throttler
const groupConfig = {
  maxConcurrent: 1,                // Only 1 job at a time
  minTime: 1000,                   // Wait this many milliseconds to be ready, after a job
  reservoir: 20,                   // Number of new jobs that throttler will accept at start
  reservoirRefreshAmount: 20,      // Number of jobs that throttler will accept after refresh
  reservoirRefreshInterval: 60000, // Interval in milliseconds where reservoir will refresh
};

// Outgoing Private Throttler
const outConfig = {
  maxConcurrent: 1,                // Only 1 job at a time
  minTime: 1000,                   // Wait this many milliseconds to be ready, after a job
};

使用量

import { Bot } from 'https://lib.deno.dev/x/grammy@1/mod.ts';
import { run } from 'https://lib.deno.dev/x/grammy_runner@1/mod.ts';
import { apiThrottler, bypassThrottler } from 'https://lib.deno.dev/x/grammy_transformer_throttler@1/mod.ts';

const botToken = Deno.env.get('BOT_TOKEN');
if (!botToken) {
  throw Error('BOT_TOKEN is required');
}
const bot = new Bot(botToken);

const throttler = apiThrottler();
bot.api.config.use(throttler);

// Experimental: Do not throttle update-initiated first response
bot.use(bypassThrottler);
bot.command('/example', ctx => ctx.reply('I am throttled'));

// If you are using throttler, you most likely want to use a runner to handle updates concurrently
run(bot);

版本与发布记录

@grammyjs/transformer-throttler 共发布 9 个版本,首次发布于 2021/05/16;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.2.1latest2022/11/134 年前
1.2.02022/11/134 年前
1.1.22022/04/084 年前
1.1.12022/01/164 年前
1.1.02022/01/164 年前
1.0.12021/09/065 年前

关于 @grammyjs/transformer-throttler 的常见问题

@grammyjs/transformer-throttler 是什么?

格莱美变压器

如何安装 @grammyjs/transformer-throttler?

在项目目录运行 npm install @grammyjs/transformer-throttler,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:grammy(^1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@grammyjs/transformer-throttler 支持 TypeScript 吗?

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

@grammyjs/transformer-throttler 支持 ESM 还是 CommonJS?

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

@grammyjs/transformer-throttler 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^12.20.0 || >=14.13.1。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@grammyjs/transformer-throttler 可以商用吗?

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

@grammyjs/transformer-throttler 的下载量有多少?

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

@grammyjs/transformer-throttler 还在维护吗?

最新版本 1.2.1 发布于 2022/11/13(4 年前);至今共发布 9 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/05/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。