README.md

stop-agenda

Gracefully stop Agenda and cancel recurring jobs

Table of Contents

• Install
• Usage
• Options
• Contributors
• License

Install

npm:

npm install stop-agenda

yarn:

yarn add stop-agenda

Usage

You should probably be using Lad's agenda directly instead of this package.

With default options:

const stopAgenda = require('stop-agenda');
const Agenda = require('agenda');

const agenda = new Agenda();

stopAgenda(agenda).then().catch(console.error);

With advanced options including custom cancel query cancelQuery and check interval in milliseconds checkIntervalMs:

const stopAgenda = require('stop-agenda');
const Agenda = require('agenda');

const agenda = new Agenda();

stopAgenda(agenda, {
  cancelQuery: {
    repeatInterval: {
      $exists: true,
      $ne: null
    }
  },
  checkIntervalMs: 300
}).then().catch(console.error);

Options

stopAgenda accepts two arguments (agenda, config) and returns a Promise:

• agenda (required) - a valid instance of Agenda

• config (optional) - a configuration object which defaults to:

  {
    cancelQuery: {
      repeatInterval: {
        $exists: true,
        $ne: null
      }
    },
    // (uses `process.env.STOP_AGENDA_CHECK_INTERVAL` if set)
    checkIntervalMs: 500
  }

Contributors

Name	Website
Nick Baugh	http://niftylettuce.com/

License

MIT © Nick Baugh