npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hapi-cron-cluster

v2.1.2

Published

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

Downloads

251

Readme

hapi-cron-cluster

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)

https://github.com/antonsamper/hapi-cron

Requirements

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) [email protected]

Installation

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

$ npm install --save hapi-cron-cluster
or
$ npm install --save [email protected]  (for hapi v16)

Usage

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) => {
                        console.info('hapi cron has run');
                    }
                }]
            }
        });

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

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

allSystemsGo();

Options

  • 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
  • jobs.name - 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