@eggjs/static

中文文档
4.1.0发布于 2026/10/07MITTypeScriptES Module构建来源已验证近 30 天下载 5058

彩蛋的静态服务器插件

中文使用文档
文档目录5 节
  1. 安装
  2. 配置
  3. 问题和建议
  4. 许可证
  5. 贡献者

@eggjs/ static (英语)

NPM version Known Vulnerabilities npm download Node.js Version PRs Welcome

彩蛋的静态服务器插件, 以 @eggjs/koa- static-cache (英语)。 。 。 .

安装

@eggjs/static 是一个已内置的插件。 默认启用 .

配置

@eggjs/static 支持所有配置在 @eggjs/koa- static-cache (英语)。 。 。 . 且以下为默认配置 :

  • 前缀 : '/public/'
  • 目录 : path.join(appInfo.baseDir, 'app/public')
  • 动态 : true
  • 预装: false
  • 最大年龄 : 31536000 以圆柱形, 0 在其它洞穴中
  • 缓冲 : true 以圆柱形, false 在其它洞穴中

@eggjs/static 提供另一个选项:

  • 最大文件: 缓存项目的最大值, 仅在动态为真实时有效, 默认为 1000。 。 。 .

所有静态文件 $baseDir/app/public 可使用前缀访问 /public,所有的文件都是懒惰的.

  • 在非生产环境中,资产不会被缓存,你的修改可以立即生效.
  • 在生产环境中, @eggjs/static 将会在访问后缓存资产,您需要重新启动更新资产的进程.
  • 默认值为 $baseDir/app/public 但你也可以定义 多个目录 通过使用 dir: [dir1, dir2, ...] 或者说 dir: [dir1, { prefix: '/static2', dir: dir2 }],静态服务器将使用所有这些目录.
// {app_root}/config/config.default.ts
export default {
  static: {
    // maxAge: 31536000,
  },
};

问题和建议

请打开一个问题 这里。 。 。 .

许可证

麻省理工学院

贡献者

Contributors

制造的 贡献者-img。 。 。 .

版本与发布记录

@eggjs/static 共发布 54 个版本,首次发布于 2025/01/12;过去 12 个月发布了 33 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.1.0latest2026/10/071 个月前
4.0.22026/10/061 个月前
4.0.2-rc.1rc2026/10/061 个月前
4.0.2-rc.02026/09/231 个月前
4.0.2-beta.27beta2026/09/201 个月前
4.0.2-beta.262026/08/073 个月前

关于 @eggjs/static 的常见问题

@eggjs/static 是什么?

彩蛋的静态服务器插件

如何安装 @eggjs/static?

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

@eggjs/static 支持 TypeScript 吗?

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

@eggjs/static 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@eggjs/static 需要什么版本的 Node.js?

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

@eggjs/static 可以商用吗?

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

@eggjs/static 的下载量有多少?

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

@eggjs/static 还在维护吗?

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