https://github.com/ladjs/stop-agenda

Gracefully stop Agenda and cancel recurring jobs
https://github.com/ladjs/stop-agenda

agenda attempt db graceful handle handler mongo mongoose reconnection restart start

Last synced: 7 days ago
JSON representation

Gracefully stop Agenda and cancel recurring jobs

• Host: GitHub
• URL: https://github.com/ladjs/stop-agenda
• Owner: ladjs
• License: mit
• Created: 2017-09-10T19:33:48.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-04-08T08:03:30.000Z (over 2 years ago)
• Last Synced: 2024-10-10T16:23:43.841Z (about 1 month ago)
• Topics: agenda, attempt, db, graceful, handle, handler, mongo, mongoose, reconnection, restart, start
• Language: JavaScript
• Homepage: https://lad.js.org
• Size: 141 KB
• Stars: 2
• Watchers: 7
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stop-agenda

[![build status](https://img.shields.io/travis/ladjs/stop-agenda.svg)](https://travis-ci.org/ladjs/stop-agenda)

[![code coverage](https://img.shields.io/codecov/c/github/ladjs/stop-agenda.svg)](https://codecov.io/gh/ladjs/stop-agenda)

[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)

[![license](https://img.shields.io/github/license/ladjs/stop-agenda.svg)](<>)

> Gracefully stop [Agenda][] and cancel recurring jobs

## Table of Contents

* [Install](#install)

* [Usage](#usage)

* [Options](#options)

* [Contributors](#contributors)

* [License](#license)

## Install

[npm][]:

```sh

npm install stop-agenda

```

[yarn][]:

```sh

yarn add stop-agenda

```

## Usage

You should probably be using [Lad's agenda][lad-agenda] directly instead of this package.

> With default options:

```js

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`:

```js

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:

  ```js

  {

    cancelQuery: {

      repeatInterval: {

        $exists: true,

        $ne: null

      }

    },

    // (uses `process.env.STOP_AGENDA_CHECK_INTERVAL` if set)

    checkIntervalMs: 500

  }

  ```

## Contributors

| Name           | Website                    |

| -------------- | -------------------------- |

| **Nick Baugh** |  |

## License

[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)

## 

[npm]: https://www.npmjs.com/

[yarn]: https://yarnpkg.com/

[agenda]: https://github.com/agenda/agenda

[lad-agenda]: https://github.com/ladjs/agenda