@eggjs/schedule 5.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,313 @@
+# @eggjs/schedule
+
+[![NPM version][npm-image]][npm-url]
+[![Node.js CI](https://github.com/eggjs/egg-schedule/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-schedule/actions/workflows/nodejs.yml)
+[![Test coverage][codecov-image]][codecov-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/schedule.svg?style=flat)](https://nodejs.org/en/download/)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/schedule.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/schedule
+[codecov-image]: https://codecov.io/github/eggjs/egg-schedule/coverage.svg?branch=master
+[codecov-url]: https://codecov.io/github/eggjs/egg-schedule?branch=master
+[snyk-image]: https://snyk.io/test/npm/@eggjs/schedule/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/@eggjs/schedule
+[download-image]: https://img.shields.io/npm/dm/@eggjs/schedule.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/schedule
+
+A schedule plugin for egg, has been built-in plugin for egg enabled by default.
+
+It's fully extendable for a developer and provides a simple built-in TimerStrategy.
+
+## Usage
+
+Just add your job file to `{baseDir}/app/schedule`.
+
+```ts
+// {baseDir}/app/schedule/cleandb.ts
+import { Subscription } from 'egg';
+
+export default class CleanDB extends Subscription {
+  /**
+   * @property {Object} schedule
+   *  - {String} type - schedule type, `worker` or `all` or your custom types.
+   *  - {String} [cron] - cron expression, see [below](#cron-style-scheduling)
+   *  - {Object} [cronOptions] - cron options, see [cron-parser#options](https://github.com/harrisiirak/cron-parser#options)
+   *  - {String | Number} [interval] - interval expression in millisecond or express explicitly like '1h'. see [below](#interval-style-scheduling)
+   *  - {Boolean} [immediate] - To run a scheduler at startup
+   *  - {Boolean} [disable] - whether to disable a scheduler, usually use in dynamic schedule
+   *  - {Array} [env] - only enable scheduler when match env list
+   */
+  static get schedule() {
+    return {
+      type: 'worker',
+      cron: '0 0 3 * * *',
+      // interval: '1h',
+      // immediate: true,
+    };
+  }
+
+  async subscribe() {
+    await this.ctx.service.db.cleandb();
+  }
+}
+```
+
+You can also use function simply like:
+
+```ts
+import { EggContext } from 'egg';
+
+export const schedule = {
+  type: 'worker',
+  cron: '0 0 3 * * *',
+  // interval: '1h',
+  // immediate: true,
+}
+
+export async function task(ctx: EggContext) {
+  await ctx.service.db.cleandb();
+}
+```
+
+## Overview
+
+`@eggjs/schedule` supports both cron-based scheduling and interval-based scheduling.
+
+Schedule decision is being made by `agent` process. `agent` triggers a task and sends a message to `worker` process. Then, one or all `worker` process(es) execute the task based on schedule type.
+
+To setup a schedule task, simply create a job file in `{app_root}/app/schedule`. A file contains one job and exports `schedule` and `task` properties.
+
+The rule of thumbs is one job per file.
+
+## Task
+
+Task is a class which will be instantiated with every schedule, and a `subscribe` method will be invoked.
+
+You can get anonymous context with `this.ctx`.
+
+- ctx.method: `SCHEDULE`
+- ctx.path: `/__schedule?path=${schedulePath}&${schedule}`.
+
+To create a task, `subscribe` can be a generator function or async function. For example:
+
+```ts
+// A simple logger example
+import { Subscription } from 'egg';
+
+export default class LoggerExample extends Subscription {
+  async subscribe() {
+    this.ctx.logger.info('Info about your task');
+  }
+}
+```
+
+```ts
+// A real world example: wipe out your database.
+// Use it with caution. :)
+import { Subscription } from 'egg';
+
+export default class CleanDB extends Subscription {
+  async subscribe() {
+    await this.ctx.service.db.cleandb();
+  }
+}
+```
+
+## Scheduling
+
+`schedule` is an object that contains one required property, `type`, and optional properties, `{ cron, cronOptions, interval, immediate, disable, env }`.
+
+### Cron-style Scheduling
+
+Use [cron-parser](https://github.com/harrisiirak/cron-parser).
+
+> Note: `cron-parser` support `second` as optional that is not supported by linux crontab.
+>
+> `@hourly / @daily / @weekly / @monthly / @yearly` is also supported.
+
+```bash
+*    *    *    *    *    *
+┬    ┬    ┬    ┬    ┬    ┬
+│    │    │    │    │    |
+│    │    │    │    │    └ day of week (0 - 7) (0 or 7 is Sun)
+│    │    │    │    └───── month (1 - 12)
+│    │    │    └────────── day of month (1 - 31)
+│    │    └─────────────── hour (0 - 23)
+│    └──────────────────── minute (0 - 59)
+└───────────────────────── second (0 - 59, optional)
+```
+
+Example:
+
+```ts
+// To execute task every 3 hours
+export const schedule = {
+  type: 'worker',
+  cron: '0 0 */3 * * *',
+  cronOptions: {
+    // tz: 'Europe/Athens',
+  },
+};
+```
+
+### Interval-style Scheduling
+
+To use `setInterval`, and support [ms](https://www.npmjs.com/package/ms) conversion style
+
+Example:
+
+```ts
+// To execute task every 3 hours
+export const schedule = {
+  type: 'worker',
+  interval: '3h',
+};
+```
+
+**Notice: Egg built-in TimerStrategy will schedule each execution at a fix rate, regardless of its execution time. So you have to make sure that your actual execution time of your `task/subscribe` must be smaller than your delay time.**
+
+### Schedule Type
+
+**Build-in support is:**
+
+- `worker`: will be executed in one random worker when a schedule runs.
+- `all`: will be executed in all workers when a schedule runs.
+
+**Custom schedule:**
+
+To create a custom schedule, simply extend `agent.ScheduleStrategy` and register it by `agent.schedule.use(type, clz)`.
+You can schedule the task to be executed by one random worker or all workers with
+the built-in method `this.sendOne(...args)` or `this.sendAll(...args)` which support params,
+it will pass to `subscribe(...args)` or `task(ctx, ...args)`.
+
+```ts
+// {baseDir}/agent.ts
+import { Agent } from 'egg';
+
+export default (agent: Agent) => {
+  class CustomStrategy extends agent.ScheduleStrategy {
+    start() {
+      // such as mq / redis subscribe
+      agent.notify.subscribe('remote_task', data => {
+        this.sendOne(data);
+      });
+    }
+  }
+
+  agent.schedule.use('custom', CustomStrategy);
+}
+```
+
+Then you could use it to defined your job:
+
+```ts
+// {baseDir}/app/schedule/other.ts
+import { Subscription } from 'egg';
+
+export default class ClusterTask extends Subscription {
+  static get schedule() {
+    return {
+      type: 'custom',
+    };
+  }
+
+  async subscribe(data) {
+    console.log('got custom data:', data);
+    await this.ctx.service.someTask.run();
+  }
+}
+```
+
+## Dynamic schedule
+
+```ts
+// {baseDir}/app/schedule/sync.ts
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  class SyncTask extends app.Subscription {
+    static get schedule() {
+      return {
+        interval: 10000,
+        type: 'worker',
+        // only start task when hostname match
+        disable: require('os').hostname() !== app.config.sync.hostname,
+        // only start task at prod mode
+        env: [ 'prod' ],
+      };
+    }
+
+    async subscribe() {
+      await this.ctx.sync();
+    }
+  }
+
+  return SyncTask;
+}
+```
+
+## Configuration
+
+### Logging
+
+See `${appInfo.root}/logs/{app_name}/egg-schedule.log` which provided by [config.customLogger.scheduleLogger](https://github.com/eggjs/egg-schedule/blob/master/config/config.default.ts).
+
+```ts
+// config/config.default.ts
+import { EggAppConfig } from 'egg';
+
+export default {
+  customLogger: {
+    scheduleLogger: {
+      // consoleLevel: 'NONE',
+      // file: path.join(appInfo.root, 'logs', appInfo.name, 'egg-schedule.log'),
+    },
+  },
+} as Partial<EggAppConfig>;
+```
+
+### Customize directory
+
+If you want to add additional schedule directories, you can use this config.
+
+```ts
+// config/config.default.ts
+import { EggAppConfig } from 'egg';
+
+export default {
+  schedule: {
+    directory: [
+      'path/to/otherSchedule',
+    ],
+  },
+} as Partial<EggAppConfig>;
+```
+
+## Testing
+
+`app.runSchedule(scheduleName)` is provided by `@eggjs/schedule` plugin only for test purpose.
+
+Example:
+
+```ts
+it('test a schedule task', async () => {
+  // get app instance
+  await app.runSchedule('clean_cache');
+});
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](https://github.com/eggjs/egg-schedule/blob/master/LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-schedule)](https://github.com/eggjs/egg-schedule/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/commonjs/agent.d.ts

@@ -0,0 +1,7 @@
+import type { Agent, ILifecycleBoot } from 'egg';
+export default class Boot implements ILifecycleBoot {
+    #private;
+    constructor(agent: Agent);
+    didLoad(): Promise<void>;
+    serverDidReady(): Promise<void>;
+}

package/dist/commonjs/agent.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_util_1 = require("node:util");
+const worker_js_1 = require("./lib/strategy/worker.js");
+const all_js_1 = require("./lib/strategy/all.js");
+const debug = (0, node_util_1.debuglog)('@eggjs/schedule/agent');
+class Boot {
+    #agent;
+    constructor(agent) {
+        this.#agent = agent;
+    }
+    async didLoad() {
+        // register built-in strategy
+        this.#agent.schedule.use('worker', worker_js_1.WorkerStrategy);
+        this.#agent.schedule.use('all', all_js_1.AllStrategy);
+        // wait for other plugin to register custom strategy
+        await this.#agent.schedule.init();
+        // dispatch job finish event to strategy
+        this.#agent.messenger.on('egg-schedule', (info) => {
+            // get job info from worker
+            this.#agent.schedule.onJobFinish(info);
+        });
+        debug('didLoad');
+    }
+    async serverDidReady() {
+        // start schedule after worker ready
+        this.#agent.schedule.start();
+        debug('serverDidReady, schedule start');
+    }
+}
+exports.default = Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSx5Q0FBcUM7QUFFckMsd0RBQTBEO0FBQzFELGtEQUFvRDtBQUdwRCxNQUFNLEtBQUssR0FBRyxJQUFBLG9CQUFRLEVBQUMsdUJBQXVCLENBQUMsQ0FBQztBQUVoRCxNQUFxQixJQUFJO0lBQ3ZCLE1BQU0sQ0FBUTtJQUNkLFlBQVksS0FBWTtRQUN0QixJQUFJLENBQUMsTUFBTSxHQUFHLEtBQUssQ0FBQztJQUN0QixDQUFDO0lBRUQsS0FBSyxDQUFDLE9BQU87UUFDWCw2QkFBNkI7UUFDN0IsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLFFBQVEsRUFBRSwwQkFBYyxDQUFDLENBQUM7UUFDbkQsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLEtBQUssRUFBRSxvQkFBVyxDQUFDLENBQUM7UUFFN0Msb0RBQW9EO1FBQ3BELE1BQU0sSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsSUFBSSxFQUFFLENBQUM7UUFFbEMsd0NBQXdDO1FBQ3hDLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLEVBQUUsQ0FBQyxJQUF3QixFQUFFLEVBQUU7WUFDcEUsMkJBQTJCO1lBQzNCLElBQUksQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN6QyxDQUFDLENBQUMsQ0FBQztRQUNILEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUNuQixDQUFDO0lBRUQsS0FBSyxDQUFDLGNBQWM7UUFDbEIsb0NBQW9DO1FBQ3BDLElBQUksQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzdCLEtBQUssQ0FBQyxnQ0FBZ0MsQ0FBQyxDQUFDO0lBQzFDLENBQUM7Q0FDRjtBQTNCRCx1QkEyQkMifQ==

package/dist/commonjs/app/extend/agent.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/commonjs/app/extend/agent.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_js_1 = require("../../lib/strategy/base.js");
+const timer_js_1 = require("../../lib/strategy/timer.js");
+const schedule_js_1 = require("../../lib/schedule.js");
+const SCHEDULE = Symbol('agent#schedule');
+exports.default = {
+    /**
+     * @member agent#ScheduleStrategy
+     */
+    ScheduleStrategy: base_js_1.BaseStrategy,
+    /**
+     * @member agent#TimerScheduleStrategy
+     */
+    TimerScheduleStrategy: timer_js_1.TimerStrategy,
+    /**
+     * @member agent#schedule
+     */
+    get schedule() {
+        if (!this[SCHEDULE]) {
+            this[SCHEDULE] = new schedule_js_1.Schedule(this);
+            this.lifecycle.registerBeforeClose(() => {
+                return this[SCHEDULE].close();
+            });
+        }
+        return this[SCHEDULE];
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL2V4dGVuZC9hZ2VudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHdEQUEwRDtBQUMxRCwwREFBNEQ7QUFDNUQsdURBQWlEO0FBRWpELE1BQU0sUUFBUSxHQUFHLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0FBRTFDLGtCQUFlO0lBQ2I7O09BRUc7SUFDSCxnQkFBZ0IsRUFBRSxzQkFBWTtJQUU5Qjs7T0FFRztJQUNILHFCQUFxQixFQUFFLHdCQUFhO0lBRXBDOztPQUVHO0lBQ0gsSUFBSSxRQUFRO1FBQ1YsSUFBSSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO1lBQ3BCLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxJQUFJLHNCQUFRLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDcEMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxtQkFBbUIsQ0FBQyxHQUFHLEVBQUU7Z0JBQ3RDLE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ2hDLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ3hCLENBQUM7Q0FDSyxDQUFDIn0=

package/dist/commonjs/app/extend/application.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/commonjs/app/extend/application.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schedule_worker_js_1 = require("../../lib/schedule_worker.js");
+const SCHEDULE_WORKER = Symbol('application#scheduleWorker');
+exports.default = {
+    /**
+     * @member app#schedule
+     */
+    get scheduleWorker() {
+        if (!this[SCHEDULE_WORKER]) {
+            this[SCHEDULE_WORKER] = new schedule_worker_js_1.ScheduleWorker(this);
+        }
+        return this[SCHEDULE_WORKER];
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwbGljYXRpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL2V4dGVuZC9hcHBsaWNhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHFFQUE4RDtBQUU5RCxNQUFNLGVBQWUsR0FBRyxNQUFNLENBQUMsNEJBQTRCLENBQUMsQ0FBQztBQUU3RCxrQkFBZTtJQUNiOztPQUVHO0lBQ0gsSUFBSSxjQUFjO1FBQ2hCLElBQUksQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEVBQUUsQ0FBQztZQUMzQixJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsSUFBSSxtQ0FBYyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ25ELENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQztJQUMvQixDQUFDO0NBQ0ssQ0FBQyJ9

package/dist/commonjs/app.d.ts

@@ -0,0 +1,6 @@
+import type { Application, ILifecycleBoot } from 'egg';
+export default class Boot implements ILifecycleBoot {
+    #private;
+    constructor(app: Application);
+    didLoad(): Promise<void>;
+}

package/dist/commonjs/app.js

@@ -0,0 +1,131 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_util_1 = require("node:util");
+const node_path_1 = __importDefault(require("node:path"));
+const utils_1 = require("@eggjs/utils");
+const debug = (0, node_util_1.debuglog)('@eggjs/schedule/app');
+class Boot {
+    #app;
+    #logger;
+    constructor(app) {
+        this.#app = app;
+        this.#logger = app.getLogger('scheduleLogger');
+    }
+    async didLoad() {
+        const scheduleWorker = this.#app.scheduleWorker;
+        await scheduleWorker.init();
+        // log schedule list
+        for (const s in scheduleWorker.scheduleItems) {
+            const schedule = scheduleWorker.scheduleItems[s];
+            if (!schedule.schedule.disable) {
+                this.#logger.info('[@eggjs/schedule]: register schedule %s', schedule.key);
+            }
+        }
+        // register schedule event
+        this.#app.messenger.on('egg-schedule', async (info) => {
+            debug('app got "egg-schedule" message: %o', info);
+            const { id, key } = info;
+            this.#logger.debug(`[Job#${id}] ${key} await app ready`);
+            await this.#app.ready();
+            const schedule = scheduleWorker.scheduleItems[key];
+            this.#logger.debug(`[Job#${id}] ${key} task received by app`);
+            if (!schedule) {
+                this.#logger.warn(`[Job#${id}] ${key} unknown task`);
+                return;
+            }
+            /* istanbul ignore next */
+            if (schedule.schedule.disable) {
+                this.#logger.warn(`[Job#${id}] ${key} disable`);
+                return;
+            }
+            this.#logger.info(`[Job#${id}] ${key} executing by app`);
+            // run with anonymous context
+            const ctx = this.#app.createAnonymousContext({
+                method: 'SCHEDULE',
+                url: `/__schedule?path=${key}&${schedule.scheduleQueryString}`,
+            });
+            const start = Date.now();
+            let success;
+            let e;
+            try {
+                // execute
+                await this.#app.ctxStorage.run(ctx, async () => {
+                    return await schedule.task(ctx, ...info.args);
+                });
+                success = true;
+            }
+            catch (err) {
+                success = false;
+                e = err;
+            }
+            const rt = Date.now() - start;
+            const msg = `[Job#${id}] ${key} execute ${success ? 'succeed' : 'failed'}, used ${rt}ms.`;
+            if (success) {
+                this.#logger.info(msg);
+            }
+            else {
+                this.#logger.error(msg, e);
+            }
+            // notify agent job finish
+            this.#app.messenger.sendToAgent('egg-schedule', {
+                ...info,
+                success,
+                workerId: process.pid,
+                rt,
+                message: e?.message,
+            });
+        });
+        // for test purpose
+        const config = this.#app.config;
+        const directory = [
+            node_path_1.default.join(config.baseDir, 'app/schedule'),
+            ...config.schedule.directory,
+        ];
+        const runSchedule = async (schedulePath, ...args) => {
+            debug('[runSchedule] start schedulePath: %o, args: %o', schedulePath, args);
+            // resolve real path
+            if (node_path_1.default.isAbsolute(schedulePath)) {
+                schedulePath = (0, utils_1.importResolve)(schedulePath);
+            }
+            else {
+                for (const dir of directory) {
+                    const trySchedulePath = node_path_1.default.join(dir, schedulePath);
+                    try {
+                        schedulePath = (0, utils_1.importResolve)(trySchedulePath);
+                        break;
+                    }
+                    catch (err) {
+                        debug('[runSchedule] importResolve %o error: %s', trySchedulePath, err);
+                    }
+                }
+            }
+            debug('[runSchedule] resolve schedulePath: %o', schedulePath);
+            let schedule;
+            try {
+                schedule = scheduleWorker.scheduleItems[schedulePath];
+                if (!schedule) {
+                    throw new Error(`Cannot find schedule ${schedulePath}`);
+                }
+            }
+            catch (err) {
+                err.message = `[@eggjs/schedule] ${err.message}`;
+                throw err;
+            }
+            // run with anonymous context
+            const ctx = this.#app.createAnonymousContext({
+                method: 'SCHEDULE',
+                url: `/__schedule?path=${schedulePath}&${schedule.scheduleQueryString}`,
+            });
+            return await this.#app.ctxStorage.run(ctx, async () => {
+                return await schedule.task(ctx, ...args);
+            });
+        };
+        Reflect.set(this.#app, 'runSchedule', runSchedule);
+        debug('didLoad');
+    }
+}
+exports.default = Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLHlDQUFxQztBQUNyQywwREFBNkI7QUFJN0Isd0NBQTZDO0FBRzdDLE1BQU0sS0FBSyxHQUFHLElBQUEsb0JBQVEsRUFBQyxxQkFBcUIsQ0FBQyxDQUFDO0FBRTlDLE1BQXFCLElBQUk7SUFDdkIsSUFBSSxDQUFjO0lBQ2xCLE9BQU8sQ0FBWTtJQUNuQixZQUFZLEdBQWdCO1FBQzFCLElBQUksQ0FBQyxJQUFJLEdBQUcsR0FBRyxDQUFDO1FBQ2hCLElBQUksQ0FBQyxPQUFPLEdBQUcsR0FBRyxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0lBQ2pELENBQUM7SUFFRCxLQUFLLENBQUMsT0FBTztRQUNYLE1BQU0sY0FBYyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDO1FBQ2hELE1BQU0sY0FBYyxDQUFDLElBQUksRUFBRSxDQUFDO1FBRTVCLG9CQUFvQjtRQUNwQixLQUFLLE1BQU0sQ0FBQyxJQUFJLGNBQWMsQ0FBQyxhQUFhLEVBQUUsQ0FBQztZQUM3QyxNQUFNLFFBQVEsR0FBRyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2pELElBQUksQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLE9BQU8sRUFBRSxDQUFDO2dCQUMvQixJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyx5Q0FBeUMsRUFBRSxRQUFRLENBQUMsR0FBRyxDQUFDLENBQUM7WUFDN0UsQ0FBQztRQUNILENBQUM7UUFFRCwwQkFBMEI7UUFDMUIsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGNBQWMsRUFBRSxLQUFLLEVBQUMsSUFBSSxFQUFDLEVBQUU7WUFDbEQsS0FBSyxDQUFDLG9DQUFvQyxFQUFFLElBQUksQ0FBQyxDQUFDO1lBQ2xELE1BQU0sRUFBRSxFQUFFLEVBQUUsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDO1lBQ3pCLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLFFBQVEsRUFBRSxLQUFLLEdBQUcsa0JBQWtCLENBQUMsQ0FBQztZQUN6RCxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7WUFDeEIsTUFBTSxRQUFRLEdBQUcsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLENBQUMsQ0FBQztZQUNuRCxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxRQUFRLEVBQUUsS0FBSyxHQUFHLHVCQUF1QixDQUFDLENBQUM7WUFFOUQsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO2dCQUNkLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsRUFBRSxLQUFLLEdBQUcsZUFBZSxDQUFDLENBQUM7Z0JBQ3JELE9BQU87WUFDVCxDQUFDO1lBRUQsMEJBQTBCO1lBQzFCLElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxPQUFPLEVBQUUsQ0FBQztnQkFDOUIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLEtBQUssR0FBRyxVQUFVLENBQUMsQ0FBQztnQkFDaEQsT0FBTztZQUNULENBQUM7WUFFRCxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxRQUFRLEVBQUUsS0FBSyxHQUFHLG1CQUFtQixDQUFDLENBQUM7WUFFekQsNkJBQTZCO1lBQzdCLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsc0JBQXNCLENBQUM7Z0JBQzNDLE1BQU0sRUFBRSxVQUFVO2dCQUNsQixHQUFHLEVBQUUsb0JBQW9CLEdBQUcsSUFBSSxRQUFRLENBQUMsbUJBQW1CLEVBQUU7YUFDL0QsQ0FBQyxDQUFDO1lBRUgsTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1lBRXpCLElBQUksT0FBZ0IsQ0FBQztZQUNyQixJQUFJLENBQW9CLENBQUM7WUFDekIsSUFBSSxDQUFDO2dCQUNILFVBQVU7Z0JBQ1YsTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLEtBQUssSUFBSSxFQUFFO29CQUM3QyxPQUFPLE1BQU0sUUFBUSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ2hELENBQUMsQ0FBQyxDQUFDO2dCQUNILE9BQU8sR0FBRyxJQUFJLENBQUM7WUFDakIsQ0FBQztZQUFDLE9BQU8sR0FBUSxFQUFFLENBQUM7Z0JBQ2xCLE9BQU8sR0FBRyxLQUFLLENBQUM7Z0JBQ2hCLENBQUMsR0FBRyxHQUFHLENBQUM7WUFDVixDQUFDO1lBRUQsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLEtBQUssQ0FBQztZQUU5QixNQUFNLEdBQUcsR0FBRyxRQUFRLEVBQUUsS0FBSyxHQUFHLFlBQVksT0FBTyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLFFBQVEsVUFBVSxFQUFFLEtBQUssQ0FBQztZQUMxRixJQUFJLE9BQU8sRUFBRSxDQUFDO2dCQUNaLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ3pCLENBQUM7aUJBQU0sQ0FBQztnQkFDTixJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLENBQUM7WUFDN0IsQ0FBQztZQUVELDBCQUEwQjtZQUMxQixJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxXQUFXLENBQUMsY0FBYyxFQUFFO2dCQUM5QyxHQUFHLElBQUk7Z0JBQ1AsT0FBTztnQkFDUCxRQUFRLEVBQUUsT0FBTyxDQUFDLEdBQUc7Z0JBQ3JCLEVBQUU7Z0JBQ0YsT0FBTyxFQUFFLENBQUMsRUFBRSxPQUFPO2FBQ0UsQ0FBQyxDQUFDO1FBQzNCLENBQUMsQ0FBQyxDQUFDO1FBRUgsbUJBQW1CO1FBQ25CLE1BQU0sTUFBTSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDO1FBQ2hDLE1BQU0sU0FBUyxHQUFHO1lBQ2hCLG1CQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxPQUFPLEVBQUUsY0FBYyxDQUFDO1lBQ3pDLEdBQUcsTUFBTSxDQUFDLFFBQVEsQ0FBQyxTQUFTO1NBQzdCLENBQUM7UUFDRixNQUFNLFdBQVcsR0FBRyxLQUFLLEVBQUUsWUFBb0IsRUFBRSxHQUFHLElBQVcsRUFBRSxFQUFFO1lBQ2pFLEtBQUssQ0FBQyxnREFBZ0QsRUFBRSxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUM7WUFFNUUsb0JBQW9CO1lBQ3BCLElBQUksbUJBQUksQ0FBQyxVQUFVLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQztnQkFDbEMsWUFBWSxHQUFHLElBQUEscUJBQWEsRUFBQyxZQUFZLENBQUMsQ0FBQztZQUM3QyxDQUFDO2lCQUFNLENBQUM7Z0JBQ04sS0FBSyxNQUFNLEdBQUcsSUFBSSxTQUFTLEVBQUUsQ0FBQztvQkFDNUIsTUFBTSxlQUFlLEdBQUcsbUJBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLFlBQVksQ0FBQyxDQUFDO29CQUNyRCxJQUFJLENBQUM7d0JBQ0gsWUFBWSxHQUFHLElBQUEscUJBQWEsRUFBQyxlQUFlLENBQUMsQ0FBQzt3QkFDOUMsTUFBTTtvQkFDUixDQUFDO29CQUFDLE9BQU8sR0FBRyxFQUFFLENBQUM7d0JBQ2IsS0FBSyxDQUFDLDBDQUEwQyxFQUFFLGVBQWUsRUFBRSxHQUFHLENBQUMsQ0FBQztvQkFDMUUsQ0FBQztnQkFDSCxDQUFDO1lBQ0gsQ0FBQztZQUVELEtBQUssQ0FBQyx3Q0FBd0MsRUFBRSxZQUFZLENBQUMsQ0FBQztZQUM5RCxJQUFJLFFBQXlCLENBQUM7WUFDOUIsSUFBSSxDQUFDO2dCQUNILFFBQVEsR0FBRyxjQUFjLENBQUMsYUFBYSxDQUFDLFlBQVksQ0FBQyxDQUFDO2dCQUN0RCxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7b0JBQ2QsTUFBTSxJQUFJLEtBQUssQ0FBQyx3QkFBd0IsWUFBWSxFQUFFLENBQUMsQ0FBQztnQkFDMUQsQ0FBQztZQUNILENBQUM7WUFBQyxPQUFPLEdBQVEsRUFBRSxDQUFDO2dCQUNsQixHQUFHLENBQUMsT0FBTyxHQUFHLHFCQUFxQixHQUFHLENBQUMsT0FBTyxFQUFFLENBQUM7Z0JBQ2pELE1BQU0sR0FBRyxDQUFDO1lBQ1osQ0FBQztZQUVELDZCQUE2QjtZQUM3QixNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLHNCQUFzQixDQUFDO2dCQUMzQyxNQUFNLEVBQUUsVUFBVTtnQkFDbEIsR0FBRyxFQUFFLG9CQUFvQixZQUFZLElBQUksUUFBUSxDQUFDLG1CQUFtQixFQUFFO2FBQ3hFLENBQUMsQ0FBQztZQUNILE9BQU8sTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLEtBQUssSUFBSSxFQUFFO2dCQUNwRCxPQUFPLE1BQU0sUUFBUSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztZQUMzQyxDQUFDLENBQUMsQ0FBQztRQUNMLENBQUMsQ0FBQztRQUNGLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxhQUFhLEVBQUUsV0FBVyxDQUFDLENBQUM7UUFFbkQsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ25CLENBQUM7Q0FDRjtBQW5JRCx1QkFtSUMifQ==

package/dist/commonjs/config/config.default.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Record<string, any>;
+export default _default;

package/dist/commonjs/config/config.default.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = () => {
+    const config = {};
+    config.customLogger = {
+        scheduleLogger: {
+            consoleLevel: 'NONE',
+            file: 'egg-schedule.log',
+        },
+    };
+    config.schedule = {
+        // custom additional directory, full path
+        directory: [],
+    };
+    return config;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsa0JBQWUsR0FBRyxFQUFFO0lBQ2xCLE1BQU0sTUFBTSxHQUFHLEVBQXlCLENBQUM7SUFFekMsTUFBTSxDQUFDLFlBQVksR0FBRztRQUNwQixjQUFjLEVBQUU7WUFDZCxZQUFZLEVBQUUsTUFBTTtZQUNwQixJQUFJLEVBQUUsa0JBQWtCO1NBQ3pCO0tBQ0YsQ0FBQztJQUVGLE1BQU0sQ0FBQyxRQUFRLEdBQUc7UUFDaEIseUNBQXlDO1FBQ3pDLFNBQVMsRUFBRSxFQUFFO0tBQ2QsQ0FBQztJQUVGLE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQyJ9

package/dist/commonjs/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/types.js';

package/dist/commonjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./lib/types.js"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGlEQUErQiJ9

package/dist/commonjs/lib/load_schedule.d.ts

@@ -0,0 +1,3 @@
+import type { EggApplicationCore } from 'egg';
+import type { EggScheduleItem } from './types.js';
+export declare function loadSchedule(app: EggApplicationCore): Promise<Record<string, EggScheduleItem>>;