adonis5-scheduler
TypeScript icon, indicating that this package has built-in type declarations

2.1.1 • Public • Published

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 adonis5-scheduler

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

Package Sidebar

Install

npm i adonis5-scheduler

Weekly Downloads

4,489

Version

2.1.1

License

MIT

Unpacked Size

30.6 kB

Total Files

25

Last publish

Collaborators

  • beatlelab