ksmf/src/task/cron/index.js

Modular Microframework for create minimalistic CLI/Web application or REST API

/**
 * @author		Antonio Membrides Espinosa
 * @date		07/04/2021
 * @copyright  	Copyright (c) 2020-2030
 * @license    	MIT
 * @version    	1.0
 * @dependency  node-cron
 **/
class CronModule {

    /**
     * @type {Object|null}
     */
    helper = null;

    /**
     * @type {Console|null}
     */
    logger = null;

    /**
     * @description configure on initialize configurations event
     */
    onInitConfig(cfg) {
        if (cfg?.srv?.cron) {
            this.configure(cfg.srv.cron, cfg.env);
        }
    }

    /**
     * @description configure the cron handler
     * @param {Object} options 
     * @param {Object} env 
     */
    configure(options, env) {
        this.env = env || {};
        this.schedule = options || [];
        this.task = {};
        for (let i in this.schedule) {
            this.booking(this.schedule[i], i);
        }
    }

    /**
     * @description create scheduled task
     * @param {Object} opt 
     * @param {String} key 
     */
    booking(opt, key) {
        if (!this.helper) return null;
        const cron = this.helper.get({
            name: 'node-cron',
            type: 'lib'
        });
        const value = opt.env ? this.env[opt.env] : opt.value;
        if (!value?.trim()) return;
        const task = cron.schedule(value, () => {
            this.helper.get(opt.target);
        }, {
            scheduled: false
        });
        task.start();
        this.task[key] = task;
    }
}
module.exports = CronModule;