Skip to content
Go to file
This branch is 15 commits ahead, 37 commits behind antonsamper:master.

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


A Hapi plugin to setup cron jobs that will call predefined server routes at specified times with leader election (cluster mode)

Based and fork from (credits)


This plugin is compatible with hapi v17+ and requires Node v8+. If you need a version compatible with hapi v16 please install version 1.1.1. The plugin need to connect to mongo or redis (for leader election) hapi-cron-cluster@1.1.1


Add hapi-cron-cluster as a dependency to your project:

$ npm install --save hapi-cron-cluster
$ npm install --save hapi-cron-cluster@1.1.1  (for hapi v16)


const Hapi = require('hapi');
const HapiCron = require('hapi-cron-cluster');

const server = new Hapi.Server();

async function allSystemsGo() {

    try {
        await server.register({
            plugin: HapiCron,
            options: {
                lock: {
                    url: 'mongodb://localhost/test', // 'redis://localhost'
                    key: 'lockTest',
                    ttl: 5000,
                    retry: 1000
                jobs: [{
                    name: 'testcron',
                    time: '*/10 * * * * *',
                    timezone: 'Europe/London',
                    request: {
                        method: 'GET',
                        url: '/test-url'
                    onComplete: (res) => {
              'hapi cron has run');

            method: 'GET',
            path: '/test-url',
            handler: function (request, h) {
                return 'hello world'

        await server.start();
    catch (err) {'there was an error');



  • lock - object that contains params for cluster leader election
  • lock.url - mongodb or redis url
  • lock.key - group key for leader election
  • lock.ttl - time to live when lock acquire
  • lock.retry - wait time brefore retrying to get the lock
  • - A unique name for the cron job
  • jobs.time - A valid cron value. See cron configuration
  • jobs.timezone - A valid timezone
  • jobs.request - The request object containing the route url path. Other options can also be passed into the request object
    • url - Route path to request
    • method - Request method (defaults to GET) - optional
  • onComplete - Function to run after the route has been requested. The function will contain the response from the request - optional

Cron configuration

This plugin uses the node-cron module to setup the cron job.

Available cron patterns:

Asterisk. E.g. *
Ranges. E.g. 1-3,5
Steps. E.g. */2

Read up on cron patterns here. Note the examples in the link have five fields, and 1 minute as the finest granularity, but the node cron module allows six fields, with 1 second as the finest granularity.

Cron Ranges

When specifying your cron values you'll need to make sure that your values fall within the ranges. For instance, some cron's use a 0-7 range for the day of week where both 0 and 7 represent Sunday. We do not.

  • Seconds: 0-59
  • Minutes: 0-59
  • Hours: 0-23
  • Day of Month: 1-31
  • Months: 0-11
  • Day of Week: 0-6


🕰️ Cron jobs for internal hapi.js routes (cluster mode - leader election)




No packages published
You can’t perform that action at this time.