Skip to content
An AdonisJS provider for Kue
JavaScript HTML
Branch: master
Clone or download
Latest commit 251ff0f May 20, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin support for Adonis 4.x Nov 22, 2017
examples support for Adonis 4.x Nov 22, 2017
providers add job/queue generator Mar 16, 2018
src Merge branch 'master' into options-object Apr 22, 2018
templates add job/queue generator Mar 16, 2018
test update dependencies May 20, 2018
.gitignore add job/queue generator Mar 16, 2018
.npmignore add travis ci config file Nov 22, 2017
.travis.yml add travis ci config file Nov 22, 2017
CONTRIBUTORS.md add contributors Nov 24, 2017
LICENSE Add project scaffolding and provider stub Jun 23, 2016
README.md Merge branch 'master' into options-object Apr 22, 2018
japaFile.js support for Adonis 4.x Nov 22, 2017
package-lock.json
package.json update dependencies May 20, 2018

README.md

Adonis Kue Provider

A Kue provider for the Adonis framework.

This library provides an easy way to get started with an asynchronous job queue for AdonisJS.

Install

npm install --save adonis-kue

Configure

Register the kue provider in start/app.js:

const providers = [
  ...
  'adonis-kue/providers/KueProvider'
]

Register the commands provider in start/app.js:

const aceProviders = [
  ...
  'adonis-kue/providers/CommandsProvider'
]

Register the jobs in start/app.js:

const jobs = [
  ...
  'App/Jobs/Example'
]

And then export the jobs array:

module.exports = { providers, aceProviders, aliases, commands, jobs }

Add a configuration file in config/kue.js. For example:

'use strict'

const Env = use('Env')

module.exports = {
  // redis connection
  connection: Env.get('KUE_CONNECTION', 'kue')
}

Usage

Command List

Command Description
adonis kue:listen Starting the listener
adonis make:job Make a new Job (Queue)

Starting the listener

Starting an instance of the kue listener is easy with the included ace command. Simply run ./ace kue:listen or adonis kue:listen.

Creating your first job

They expose the following properties:

Name Required Type Static Description
concurrency false number true The number of concurrent jobs the handler will accept
key true string true A unique key for this job
handle true function false A function that is called for this job.

Here's an example.

Dispatching jobs

Now that your job listener is running and ready to do some asynchronous work, you can start dispatching jobs.

const kue = use('Kue')
const Job = use('App/Jobs/Example')
const data = { test: 'data' } // Data to be passed to job handle
const priority = 'normal' // Priority of job, can be low, normal, medium, high or critical
const attempts = 1 // Number of times to attempt job if it fails
const remove = true // Should jobs be automatically removed on completion
const jobFn = job => { // Function to be run on the job before it is saved
  job.backoff()
}
const job = kue.dispatch(Job.key, data, { priority, attempts, remove, jobFn })

// If you want to wait on the result, you can do this
const result = await job.result

Thanks

Special thanks to the creator(s) of AdonisJS for creating such a great framework.

You can’t perform that action at this time.