Adonis Scheduler Provider
This library provides an easy way to schedule recurring tasks for AdonisJS v4.
Use branch adonis-v3 for AdonisJS version 3
npm install --save adonis-scheduler
Register it in
const providers = ... 'adonis-scheduler/providers/SchedulerProvider' const aliases = ... Scheduler: 'Adonis/Addons/Scheduler'
Register the commands:
const aceProviders = ... 'adonis-scheduler/providers/CommandsProvider'
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:
|The schedule for which the task should run. More docs.
|A function that is called for this task.
Special thanks to the creator(s) of AdonisJS for creating such a great framework.