- Notifications
You must be signed in to change notification settings - Fork24
Javascript Cron Time Expressions
License
trapcodeio/cron-time
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Cron Time Expression Generator/Builder written in Typescript.
Tested onCronTab.Guru
npm install cron-time-generatorOR
yarn add cron-time-generator// Javascriptconst{CronTime}=require('cron-time-generator');// ORconst{default:CronTime}=require('cron-time-generator');// Typescriptimport{CronTime}from"cron-time-generator";// ORimportCronTimefrom"cron-time-generator";
TheCronTime class is the main class that contains all the methods for generating cron expressions.it is the default export of the package and also has a named export calledCronTime
CronTime.everyMinute();// * * * * *CronTime.everyHour();// 0 * * * *CronTime.everyDay();// 0 0 * * *CronTime.everyDayAt(6);// 0 6 * * *CronTime.everyDayAt(6,15);// 15 6 * * *CronTime.everySunday();// 0 0 * * SUNCronTime.everySundayAt(4,30);// 30 4 * * SUNCronTime.everyWeekDay();// 0 0 * * 1-5// from Monday to FridayCronTime.everyWeekDayAt(1,30);// 30 1 * * 1-5// 1:30 AM from Monday to FridayCronTime.everyWeekend();// 0 0 * * 6,0// on Saturday and SundayCronTime.everyWeekendAt(1,30);// 30 1 * * 6,0// 1:30 AM on Saturday and Sunday// E.T.C
ForeveryWeekDay andeveryWeekend there is also an option to change the starting day.
By default, week days is fromMonday toFriday while weekend days areSaturdays andSundays
This can be changed like so:
CronTime.everyWeekDay("sunday","thursday");// 0 0 * * 0-4// from Sunday to ThursdayCronTime.everyWeekDayAt(1,30,"sunday","thursday");// 30 1 * * 0-4// 1:30 AM from Sunday to ThursdayCronTime.everyWeekend("friday","saturday");// 0 0 * * 5,6// on Friday and SaturdayCronTime.everyWeekendAt(1,30,"friday","saturday");// 30 1 * * 5,6// 1:30 AM on Friday and Saturday
Note: if astartDay is specified then anendDay must be specified also, else it will use the default values whichmay not tally with your new$startDay
Every method ofCronTime returns exactly what its name says.
To target specific days
CronTime.onSpecificDays(['sunday','tuesday','thursday']);// 0 0 * * 0,2,4// With timeCronTime.onSpecificDaysAt(['sunday','tuesday','thursday'],3,30);// 0 0 * * 0,2,4
constCronTime=require('cron-time-generator');CronTime.every(5).minutes();// Every Five MinutesCronTime.every(2).hours();// Every 2 HoursCronTime.every(7).days();// Every 7 DaysCronTime.every(7).days(9,5);// Every 7 days at 9:05CronTime.every('even').hours();// Every Even Hours// * */2 * * *CronTime.every('uneven').hours();// Every Uneven Hours// * 1-23/2 * * *
const{CronTime}=require('cron-time-generator');CronTime.between(1,4).days();// Between 1 - 4 th day of the month
every
between
everyMinute
everyHour
everyHourAt(minuteOfTheHour)
everyDay
everyDayAt(hoursOfTheDay)
everySunday
everySundayAt(hours, minutes?)
everyMonday
everyMondayAt(hours, minutes?)
everyTuesday
everyTuesdayAt(hours, minutes?)
everyWednesday
everyWednesdayAt(hours, minutes?)
everyThursday
everyThursdayAt(hours, minutes?)
everyFriday
everyFridayAt(hours, minutes?)
everySaturday
everySaturdayAt(hours, minutes?)
everyWeek
everyWeekAt(days, hours?, minutes?)
everyWeekDay
everyWeekDayAt(hours, minutes?, startDay?, endDay?)
everyWeekend
everyWeekendAt(hours, minutes?, startDay?, endDay?)
everyMonth
everyMonthOn(days, hours?, minutes?)
everyYear
everyYearIn(months, days?, hours?, minutes?)
onSpecificDays(days)
onSpecificDaysAt(days, hour, minutes?)
About
Javascript Cron Time Expressions
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors6
Uh oh!
There was an error while loading.Please reload this page.