# @grammyjs/files 中文文档

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

版本：1\.2\.0
npm 元数据更新时间：2025-09-18T15:13:36.140Z
中文译文更新时间：2026-11-16T22:05:02.809Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：17.6 kB，11 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^12\.20\.0 \|\| \>=14\.13\.1
- 运行依赖：0 个
- peer 依赖：grammy ^1\.3\.0
- 首次发布：2021-08-16T10:53:47.485Z
- 最新版本发布：2025-09-18T15:13:35.923Z
- 近 30 天下载量：32124（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

GrammY 的文件插件

## 安装

```sh
npm install @grammyjs/files
```

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

## README

# 在 grammY 中简化文件处理

此插件允许您从Telegram服务器轻松下载文件 . 检查出来 [官方插件页面](https://grammy.dev/plugins/files.html) 以备进一步的文件.

## 示例

```ts
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 是什么？

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

