Adonis Scheduler Provider

[![NPM Version][npm-image]][npm-url]

This library provides an easy way to schedule recurring tasks for AdonisJS v4.

Install

``
npm install --save adonis-cron
`

Configure

Register it in start/app.js:

`javascript
const providers = [
...
'adonis-cron/providers/SchedulerProvider'
]

const aliases = {
...
Scheduler: 'Adonis/Addons/Scheduler'
}
`

Register the commands:

`javascript
const aceProviders = [
...
'adonis-cron/providers/CommandsProvider'
]
`

Usage

$3

Starting an instance of the kue listener is easy with the included ace command. Simply run node ace run:scheduler.

The provider looks for jobs in the app/Tasks directory of your AdonisJS project and will automatically register a handler for any tasks that it finds.

$3

Jobs are easy to create. Run node ace make:task Example`. They expose the following properties:

| Name | Required | Type | Static | Description |
|-------------|----------|-----------|--------|--------------------------------------------------------|
| schedule | true | many | true | The schedule for which the task should run. More docs. |
| handle | true | function | false | A function that is called for this task. |

Thanks

Special thanks to the creator(s) of AdonisJS for creating such a great framework.

[npm-image]: https://img.shields.io/npm/v/adonis-cron.svg?style=flat-square
[npm-url]: https://npmjs.org/package/adonis-cron