@eggjs/schedule-decorator

Install
npm i --save @eggjs/schedule-decorator
Define schedule subscriber
import { Schedule } from '@eggjs/tegg';
// use number to define schedule interval
@Schedule<IntervalParams>({
type: ScheduleType.WORKER,
scheduleData: {
// run every 100ms
interval: 100,
},
})
export class FooSubscriber {
@Inject()
private readonly logger: EggLogger;
async subscribe() {
this.logger.info('schedule called');
}
}
// use cron to define schedule interval
@Schedule<CronParams>({
type: ScheduleType.WORKER,
scheduleData: {
cron: '0 0 3 * * *',
},
})
export class FooSubscriber {
@Inject()
private readonly logger: EggLogger;
async subscribe() {
this.logger.info('schedule called');
}
}
关于 @eggjs/schedule-decorator 的常见问题
@eggjs/schedule-decorator 是什么?
tegg schedule decorator
如何安装 @eggjs/schedule-decorator?
在项目目录运行 npm install @eggjs/schedule-decorator,或使用 pnpm add / yarn add / bun add。
@eggjs/schedule-decorator 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@eggjs/schedule-decorator 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@eggjs/schedule-decorator 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@eggjs/schedule-decorator 可以商用吗?
@eggjs/schedule-decorator 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@eggjs/schedule-decorator 的下载量有多少?
根据 npm 官方下载统计,@eggjs/schedule-decorator 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,864 次,日均约 129 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@eggjs/schedule-decorator 还在维护吗?
最新版本 4.1.0 发布于 2026/10/07(1 个月前);至今共发布 39 个版本,其中过去 12 个月发布了 33 个;首次发布于 2025/10/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。