@grammyjs/stream

中文文档
1.1.0发布于 2026/06/19MITTypeScriptCommonJS近 30 天下载 1.4万

Stream long text messages to Telegram

原始使用文档

grammY stream

Stream long text messages to Telegram. Make LLM output appear as animated message drafts before sending the message.

Quickstart

Here is a quickstart for you, but be sure to check out the real documentation on the website.

Run npm i grammy @grammyjs/stream @grammyjs/auto-retry and paste the following code:

import { Bot, type Context } from "grammy";
import { autoRetry } from "@grammyjs/auto-retry";
import { stream, type StreamFlavor } from "@grammyjs/stream";

type MyContext = StreamFlavor<Context>;

const bot = new Bot<MyContext>("");

bot.api.config.use(autoRetry());
bot.use(stream());

async function* slowText() {
    // emulate slow text generation
    yield "This i";
    await new Promise((r) => setTimeout(r, 1000));
    yield "s some sl";
    await new Promise((r) => setTimeout(r, 1000));
    yield "owly gene";
    await new Promise((r) => setTimeout(r, 1000));
    yield "rated text";
}

bot.command("stream", async (ctx) => {
    await ctx.replyWithStream(slowText());
});

bot.command("start", (ctx) => ctx.reply("Hi! Send /stream"));
bot.use((ctx) => ctx.reply("What a nice update."));

bot.start();

For example, if you use the AI SDK, your AI setup could look like this:

import { streamText } from "ai";
import { google } from "@ai-sdk/google";

bot.command("credits", async (ctx) => {
    // Send prompt to LLM:
    const { textStream } = streamText({
        model: google("gemini-2.5-flash"),
        prompt: "How cool are grammY bots?",
    });

    // Automatically stream response with grammY:
    await ctx.replyWithMarkdownStream(textStream);
});

Consider including information about Telegram's rich message formatting options in your prompt if your LLM requires some guidance on this.

版本与发布记录

@grammyjs/stream 共发布 4 个版本,首次发布于 2025/12/31;过去 12 个月发布了 4 个版本。

版本发布日期距今
1.1.0latest2026/06/194 个月前
1.0.12026/03/048 个月前
1.0.02025/12/3110 个月前
0.1.02025/12/3110 个月前

关于 @grammyjs/stream 的常见问题

@grammyjs/stream 是什么?

Stream long text messages to Telegram

如何安装 @grammyjs/stream?

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

@grammyjs/stream 支持 TypeScript 吗?

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

@grammyjs/stream 支持 ESM 还是 CommonJS?

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

@grammyjs/stream 需要什么版本的 Node.js?

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

@grammyjs/stream 可以商用吗?

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

@grammyjs/stream 的下载量有多少?

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

@grammyjs/stream 还在维护吗?

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