Funcron

A library to schedule function calls, for NodeJS and the browser.

Important Notes

To be honest, this is intented mostly for browser and client-side usage, as in node js and server enviroments, you might want to use other, more "stable" solutions, like cron jobs. Funcron is using timeouts to schedule its functions, and while in theory it should work for longer time period, circumstances might vary from system to system so there might be some problems. So do not use funcron for very long term task scheduling. By default Funcron is designed to be used on a 1-day time period, but you can easily bypass that by using hook events.

Examples

Depending on your enviroment you'll have to require Funcron, or include it directly on your browser via script tags

Funcron accepts one object as arguement with the following parameters:

Command	Description
timeSlots	array of object in timeformat
maxTimeslotTime	time in seconds that will call the default function after a scheduled function is called
defaultFn	the default function /
onScheduleStart	the function to be called if the schedule is initiated before the first time slot/
onScheduleEnd	the function to be called after the last timeslot./
defaultFnMaxCalls	times the default function is allowed to be called between two timeslots/

Format of timeSlots is an array of object that contains a time and an fn property. the time must be on the format hh:mm:ss

var times =  [
    {time:'18:30:00',fn:(secs)=>showdate(secs)},
    {time:'18:32:00',fn:(secs)=>showdate(secs)},
    {time:'18:33:00',fn:(secs)=>showdate(secs)},
    {time:'18:34:30',fn:(secs)=>showdate(secs)},
    {time:'18:35:30',fn:(secs)=>showdate(secs)},
    {time:'18:36:00',fn:(secs)=>showdate(secs)},
    {time:'18:37:30',fn:(secs)=>showdate(secs)},
    {time:'18:38:00',fn:(secs)=>showdate(secs)},
    {time:'18:39:00',fn:(secs)=>showdate(secs)},
    {time:'19:00:00',fn:(secs)=>showdate(secs)},

];
    

create a new instance of Funcron, if you don't want the default function functionality, you can just omit maxTimeslotTime and defaultFn. By doing that, funcron will just run the fn functions from provided inside each timeslot.

let sch = new Funcron({
    timeSlots:times2,
    maxTimeslotTime:60,
    onScheduleStart:function () {
        console.log('schedule started!');
        d = new Date();
        console.log("Default:"+d.getHours()+":"+d.getMinutes()+":"+d.getSeconds());

    },
    onScheduleEnd:function () {
        sch.startTimeSchedule(1)
    },
    defaultFn:function (milliseconds) {
        d = new Date();
        console.log("Default:"+d.getHours()+":"+d.getMinutes()+":"+d.getSeconds()+' next call in '+(milliseconds/1000)+' secs');
    },
    defaultFnMaxCalls:1
});

start Funcron;

funcron.startTimeSchedule();

lets suppose time is 12:10:00 so funcron will run the 12:00:00 fn function, the next function to be called will be at 13:00:00. Notice now, that in the timeslots array we intentionally left an hour blank. Since we have setted the maxTimeslotTime at 60*60 (1 hour) secs the next function that will run at 14:00:00 will be the defaultFn and then at 17:00:00 the corresponding fn

for a better understanding of maxSchTime consider the following timeslots

    var timeslots = [
    {time:'11:00:00' ,fn:function() { console.log('i am '+this.time )}},
    {time:'12:00:00' ,fn:function() { console.log('i am '+this.time )}},
    {time:'13:00:00' ,fn:function() { console.log('i am '+this.time )}},
    {time:'15:00:00' ,fn:function() { console.log('i am '+this.time )}},
    {time:'16:00:00' ,fn:function() { console.log('i am '+this.time )}},
    {time:'17:00:00' ,fn:function() { console.log('i am '+this.time )}}
    ]

if the maxTimeslotTime is setted on 10 mins (60*10) and the time that funcron will start is at 11:10:00, the first function to be called will be the defaultFn. then at 12:00:00 the corresponding fn and after that at 12:10:00 the default function will run again.

In case that defaultFnMaxCalls is setted the default will run as many times it is setted and can be called until the next timeslot.