@adamcikado/adonis5-scheduler

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

Usage no npm install needed!

<script type="module">
  import adamcikadoAdonis5Scheduler from 'https://cdn.skypack.dev/@adamcikado/adonis5-scheduler';
</script>

README

Table of contents

adonis5-scheduler

AdonisJS5, cron, cronjob, scheduler

travis-image typescript-image npm-image license-image

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

How it works

Installation

Install it:

npm i --save adonis5-scheduler

Compile your code:

node ace serve --watch

Connect all dependences:

node ace invoke adonis5-scheduler

Usage

Creating your first task

node ace make:task MyTaskName

Starting the scheduler

Starting an instance of the kue listener is easy with the included ace command.

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.

node ace scheduler:run
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 and nrempel creator scheduler package for Adonis v4