@grammyjs/files

中文文档
1.2.0发布于 2025/09/18MITTypeScriptCommonJS零依赖近 30 天下载 3.2万

GrammY 的文件插件

中文使用文档

在 grammY 中简化文件处理

此插件允许您从Telegram服务器轻松下载文件 . 检查出来 官方插件页面 以备进一步的文件.

示例

import { Bot, type Context } from "grammy";
import { type FileFlavor, hydrateFiles } from "@grammyjs/files";

// Transformative API flavor
type MyContext = FileFlavor<Context>;

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

// Install plugin
bot.api.config.use(hydrateFiles(bot.token));

// Download videos and GIFs to temporary files
bot.on([":video", ":animation"], async (ctx) => {
    // Prepare file for download
    const file = await ctx.getFile();
    // Download file to temporary location on your disk
    const path = await file.download();
    // Print file path
    console.log("File saved at", path);
});

您可以通过一个带文件路径的字符串 download 如果您不想创建临时文件. 随便你 await file.download('/path/to/file')。 。 。 .

版本与发布记录

@grammyjs/files 共发布 8 个版本,首次发布于 2021/08/16;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.2.0latest2025/09/181.2 年前
1.1.12024/06/052 年前
1.1.02024/02/262 年前
1.0.42022/04/174 年前
1.0.32021/12/294 年前
1.0.22021/09/065 年前

关于 @grammyjs/files 的常见问题

@grammyjs/files 是什么?

GrammY 的文件插件

如何安装 @grammyjs/files?

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

@grammyjs/files 支持 TypeScript 吗?

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

@grammyjs/files 支持 ESM 还是 CommonJS?

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

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

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

@grammyjs/files 可以商用吗?

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

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

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

@grammyjs/files 还在维护吗?

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