midway-schedule

this is a sub package for midway.

Document: https://midwayjs.org

Config

Midway has enabled this plugin by default.

// plugin.ts(js)
exports.schedulePlus = {
  enable: true,
  package: 'midway-schedule'
}

Detail

The schedule of midway is based on egg schedule, and provide more typescript and decorator support. The task can store in any file like src/schedule, it can be configured the properties and specify jobs. For example:

// src/schedule/hello.ts
import { provide, schedule, CommonSchedule } from 'midway';

@provide()
@schedule({
  interval: 2333, // 2.333s interval
  type: 'worker', // only run in certain worker
})
export class HelloCron implements CommonSchedule {
  // The detail job while times up
  async exec(ctx) {
    ctx.logger.info(process.pid, 'hello');
  }
}

It is recommended to use CommonSchedule interface to standardize your schedule class.

About run schedule

Egg provides the app.runSchedule method to test the scheduled task. The parameters of the midway are different. The format of the midway parameter is ioc id#className.

Take the example of the HelloCron class above.

app.runSchedule('helloCron#HelloCron');

Please see our test case for more detail.

License

MIT