adonis-scheduler

Easy task scheduling for AdonisJS

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
adonis-scheduler
105113.0.24 years ago6 years agoMinified + gzip package size for adonis-scheduler in KB

Readme

Adonis Scheduler Provider
!NPM Versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Appveyorappveyor-imageappveyor-url !Coverallscoveralls-imagecoveralls-url
This library provides an easy way to schedule recurring tasks for AdonisJS v4.
Use branch adonis-v3 for AdonisJS version 3

Install

npm install --save adonis-scheduler

Configure

Register it in start/app.js:
const providers = [
  ...
  'adonis-scheduler/providers/SchedulerProvider'
]

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

Register the commands:
const aceProviders = [
  ...
  'adonis-scheduler/providers/CommandsProvider'
]

Usage

Starting the scheduler

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.

Creating your first task

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.