{"id":13817599,"url":"https://github.com/nrempel/adonis-scheduler","last_synced_at":"2025-08-10T03:06:11.509Z","repository":{"id":57173616,"uuid":"62071789","full_name":"nrempel/adonis-scheduler","owner":"nrempel","description":"This library provides an easy way to schedule recurring tasks for AdonisJS.","archived":false,"fork":false,"pushed_at":"2020-08-24T13:29:23.000Z","size":123,"stargazers_count":104,"open_issues_count":10,"forks_count":31,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-09T01:05:12.822Z","etag":null,"topics":["adonis","adonisjs","cron","task-scheduler"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nrempel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-27T16:39:44.000Z","updated_at":"2023-03-17T12:06:03.000Z","dependencies_parsed_at":"2022-08-24T13:21:30.386Z","dependency_job_id":null,"html_url":"https://github.com/nrempel/adonis-scheduler","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nrempel/adonis-scheduler","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrempel%2Fadonis-scheduler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrempel%2Fadonis-scheduler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrempel%2Fadonis-scheduler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrempel%2Fadonis-scheduler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nrempel","download_url":"https://codeload.github.com/nrempel/adonis-scheduler/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrempel%2Fadonis-scheduler/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269668673,"owners_count":24456520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adonis","adonisjs","cron","task-scheduler"],"created_at":"2024-08-04T06:00:51.751Z","updated_at":"2025-08-10T03:06:11.471Z","avatar_url":"https://github.com/nrempel.png","language":"JavaScript","funding_links":[],"categories":["Packages"],"sub_categories":[],"readme":"# Adonis Scheduler Provider\n\n[![NPM Version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Appveyor][appveyor-image]][appveyor-url]\n[![Coveralls][coveralls-image]][coveralls-url]\n\nThis library provides an easy way to schedule recurring tasks for AdonisJS v4.\n\n\u003e Use branch [adonis-v3](https://github.com/nrempel/adonis-scheduler/tree/adonis-v3) for AdonisJS version 3\n\n## Install\n\n```\nnpm install --save adonis-scheduler\n```\n\n## Configure\n\nRegister it in `start/app.js`:\n\n```javascript\nconst providers = [\n  ...\n  'adonis-scheduler/providers/SchedulerProvider'\n]\n\nconst aliases = {\n  ...\n  Scheduler: 'Adonis/Addons/Scheduler'\n}\n```\n\nRegister the commands:\n\n```javascript\nconst aceProviders = [\n  ...\n  'adonis-scheduler/providers/CommandsProvider'\n]\n```\n\n## Usage\n\n### Starting the scheduler\n\nStarting an instance of the kue listener is easy with the included ace command. Simply run `node ace run:scheduler`.\n\nThe 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.\n\n### Creating your first task\n\nJobs are easy to create. Run `node ace make:task Example`. They expose the following properties:\n\n| Name        | Required | Type      | Static | Description                                           |\n|-------------|----------|-----------|--------|--------------------------------------------------------|\n| schedule    | true     | many      | true   | The schedule for which the task should run. [More docs.](https://github.com/node-schedule/node-schedule#cron-style-scheduling)      |\n| handle      | true     | function  | false  | A function that is called for this task.               |\n\n## Thanks\n\nSpecial thanks to the creator(s) of [AdonisJS](http://adonisjs.com/) for creating such a great framework.\n\n[appveyor-image]: https://img.shields.io/appveyor/ci/nrempel/adonis-scheduler/master.svg?style=flat-square\n\n[appveyor-url]: https://ci.appveyor.com/project/nrempel/adonis-scheduler\n\n[npm-image]: https://img.shields.io/npm/v/adonis-scheduler.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/adonis-scheduler\n\n[travis-image]: https://img.shields.io/travis/nrempel/adonis-scheduler/master.svg?style=flat-square\n[travis-url]: https://travis-ci.org/nrempel/adonis-scheduler\n\n[coveralls-image]: https://coveralls.io/repos/github/nrempel/adonis-scheduler/badge.svg?branch=master\n[coveralls-url]: https://coveralls.io/github/nrempel/adonis-scheduler\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnrempel%2Fadonis-scheduler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnrempel%2Fadonis-scheduler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnrempel%2Fadonis-scheduler/lists"}