node-reel-ext v2.0.2

node-reel is a heavily inspired by laravel task scheduler syntax thanks to @taylorotwell and uses node-cron by merencia as the default cron driver to run cron tasks.

Notice:

This project forked from https://github.com/shakee93/node-reel

v2.0.1 Change log:

• update "node-cron" to: "^3.0.0"
• fix a warning: (node:23300) DEP0128 DeprecationWarning: Invalid 'main' field in '\node_modules\node-reel\package.json' of 'src/index.js'. Please either fix that or report it to the module author
• add some test for main functions
• adjust options when create the new object.
• validate cron expressions when schedule job.

why node-reel ? :wink:

const reel = require('node-reel')

reel().call(() => {
	// say hello on mondays
}).weekly().mondays().at('13:00').run()

reel().command('npm run clean_trash').everyThirtyMinutes().run()

Install

using the npm or yarn

npm i node-reel --save

Schedule Frequencies

link to laravel task scheduler doc : task scheduler

Methods

Adapters

node-reel will use node-cron as default adapter. but you can pass your own adapter and return your own object.

const Reel = require('node-reel').Reel;

const reel = new Reel({
    adapter : (object) => {
    	// use your cron library or custom cron logic
    	// below are the available properties
    	let expression = object.expression;
    	let callback = object.callback;
    	let timezone = object.timezone;
    	
    	return mycron.schedule(expression, callback);
    }
})


// use it as follows
reel.command('npm run foo').hourly().run();

Monitor the Scheduled Executions

If you want to keep an eye on every execution and make sure they succeed or fail, or even if they execute at all, or make a report of each, you can:

reel().command('npm run clean_trash', (error) => {
    if (error) {
	// Handle the error
    } else {
	// Report the success
    }
}).everyThirtyMinutes().run()

Notes

issues, pull request and feedback are welcome ! Happy Scheduling !!