umairx97 / cronify

Making Cron Simple - uses node-cron under the hood

Cronify

Making Cron Simple - uses node-cron under the hood

npm

npm install cronify

yarn

yarn add cronify

🚀 Examples

Checkout the examples to see the Cronify API in action.

💡 API

cronify(params, opts<optional>, fn, fnArgs)

const cron = require('cronify')

// simple node-cron as you like it
cron.cronify('*/1 * * * * *', console.log, 'hello') // without options

// with options 
cron.cronify(
  '*/1 * * * * *', 
  { timezone: "America/Sao_Paulo" },
  console.log, 
  'hello'
) 

---

everySecond(opts<optional>, fn, fnArgs)

const cron = require('cronify')

// without options
cron.everySecond(console.log, 'hello') 

// with options
cron.everySecond({ timezone: "America/Sao_Paulo" }, console.log, 'hello')

---

everyNthSecond(seconds, opts<optional> fn, fnArgs)

const cron = require('cronify')

// without options - this will log hello world every 2 seconds
cron.everyNthSecond(2, console.log, 'hello', 'world')

// with options - this will log hello world every 2 seconds
cron.everyNthSecond(2, { timezone: "America/Sao_Paulo" } console.log, 'hello', 'world')

---

everyMinute(opts<optional>, fn, fnArgs)

const cron = require('cronify')

// without options
cron.everyMinute(console.log, 'hello') 

// with options
cron.everyMinute({ timezone: "America/Sao_Paulo" }, console.log, 'hello')

---

everyNthMinute(minutes, opts<optional>, fn, fnArgs)

const cron = require('cronify')

// without options - this will log hello world every 2 minutes
cron.everyNthMinute(2, console.log, 'hello', 'world')

// with options - this will log hello world every 2 minutes
cron.everyNthMinute(2, { timezone: "America/Sao_Paulo" } console.log, 'hello', 'world')

---

everyHour(opts<optional>, fn, fnArgs)

const cron = require('cronify')

// without options
cron.everyHour(console.log, 'hello') 

// with options
cron.everyHour({ timezone: "America/Sao_Paulo" }, console.log, 'hello')

---

everyNthHour(hours, opts<optional>, fn, fnArgs)

const cron = require('cronify')

// without options - this will log hello world every 2 hours
cron.everyNthHour(2, console.log, 'hello', 'world')

// with options - this will log hello world every 2 hours
cron.everyNthHour(2, { timezone: "America/Sao_Paulo" } console.log, 'hello', 'world')

---

at(period, opts<optional>, fn, fnArgs)

const cron = require('cronify')

/*
  period = 'daily' | 'weekly' | 'monthly'
  at
  time = hh:mm
  cron.at("period" at "time", opts<optional>, function, ...functionArgs)
  without options - this will start the job daily at 5Am BUT you need to have 
  some measure to stop the job on your own schedule See examples/at.js
*/
cron.at('daily at 5:00', console.log, 'hello', 'world')

// with options 
cron.at('daily at 5:00', { timezone: "America/Sao_Paulo" }, console.log, 'hello', 'world')