{"_id":"@appliedblockchain/adonis-kue","_rev":"218-188e0913bb41bbfe7855f9b4e2668fc3","name":"@appliedblockchain/adonis-kue","dist-tags":{"latest":"5.0.0"},"versions":{"5.0.0":{"name":"@appliedblockchain/adonis-kue","version":"5.0.0","keywords":["adonis","kue","queue"],"author":{"name":"Nicholas Rempel","email":"nbrempel@gmail.com"},"license":"MIT","_id":"@appliedblockchain/adonis-kue@5.0.0","maintainers":[{"name":"ab-ci","email":"developers@appliedblockchain.com"},{"name":"ab-incremint","email":"francesco+ab-incre-npm@appliedblockchain.com"},{"name":"alixeb","email":"alixe@webgear.pro"},{"name":"andycampbell92","email":"andycampbell92@gmail.com"},{"name":"antony","email":"aj@desirableobjects.co.uk"},{"name":"ikhemissi","email":"iheb.khemissi@gmail.com"},{"name":"jamieappliedblockchain","email":"jamie@appliedblockchain.com"},{"name":"makevoid","email":"makevoid@gmail.com"},{"name":"mariogemoll","email":"mariogemoll@gmx.net"},{"name":"mayk93","email":"mihai@mandrescu.co"},{"name":"mikehab","email":"mike@appliedblockchain.com"},{"name":"mirek","email":"mirek@me.com"},{"name":"mistersomebody","email":"npm@mistersomebody.com"},{"name":"mtomov","email":"mtomov@outlook.com"},{"name":"oktapodia","email":"sebastien.bramille@gmail.com"},{"name":"roppa_uk","email":"mark.o.robson@gmail.com"},{"name":"simontabor","email":"me@simontabor.com"}],"homepage":"https://github.com/nrempel/adonis-kue#readme","bugs":{"url":"https://github.com/nrempel/adonis-kue/issues"},"nyc":{"include":["src","providers","commands"]},"dist":{"shasum":"98af9fece524fe3cd0d6c04199354b167382dcdd","tarball":"https://registry.npmjs.org/@appliedblockchain/adonis-kue/-/adonis-kue-5.0.0.tgz","fileCount":9,"integrity":"sha512-GdmkkKL39ifIARIbTwHqM8TXKnB4SoYI/L0/UzJYKQM5PWAFaBgC8rrBdadqAXHiB5uup+CQwcmljbtU0Ix9SQ==","signatures":[{"sig":"MEYCIQDZsHL3eSdaEJq7oLJOKI7kLgEiXN9/0TIQSEWjc3AsAwIhAL73dK2ODig2ezQHc+V7nyt4J6YGIIpNQadgco78YSad","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11167},"main":"src/Kue/index.js","gitHead":"16b2f8cebf90daea64cddcb95cc12dd0284ec7c4","scripts":{"lint":"standard","test":"ENV_SILENT=true NO_ANSI=false FORCE_COLOR=true nyc node ./bin/index.js --local","prepush":"npm run test && lint-staged","pretest":"npm run lint","coverage":"nyc report --reporter=text-lcov","lint:fix":"standard --fix","posttest":"npm run coverage","precommit":"npm run test && lint-staged"},"_npmUser":{"name":"simontabor","email":"me@simontabor.com"},"standard":{"globals":["use","make"]},"repository":{"url":"git+https://github.com/nrempel/adonis-kue.git","type":"git"},"_npmVersion":"5.3.0","description":"Kue provider for the Adonis framework","directories":{"test":"test"},"lint-staged":{"*.js":["npm run lint:fix","git add"]},"_nodeVersion":"8.9.4","dependencies":{"kue":"^0.11.6"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^11.3.0","japa":"^1.0.5","husky":"^0.13.4","dotenv":"^4.0.0","semver":"^5.3.0","japa-cli":"^1.0.1","standard":"^10.0.2","coveralls":"^3.0.0","walk-sync":"^0.3.2","lint-staged":"^4.0.0","@adonisjs/ace":"^4.0.7","child_process":"^1.0.2","@adonisjs/fold":"^4.0.5","@adonisjs/sink":"^1.0.13","@adonisjs/redis":"^2.0.3","@adonisjs/framework":"^4.0.27"},"_npmOperationalInternal":{"tmp":"tmp/adonis-kue_5.0.0_1520337857890_0.723407312793088","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-03-06T12:04:17.888Z","modified":"2026-08-28T12:49:13.067Z","5.0.0":"2018-03-06T12:04:18.142Z"},"bugs":{"url":"https://github.com/nrempel/adonis-kue/issues"},"author":{"name":"Nicholas Rempel","email":"nbrempel@gmail.com"},"license":"MIT","homepage":"https://github.com/nrempel/adonis-kue#readme","keywords":["adonis","kue","queue"],"repository":{"url":"git+https://github.com/nrempel/adonis-kue.git","type":"git"},"description":"Kue provider for the Adonis framework","maintainers":[{"email":"palhais.diogo@gmail.com","name":"diogopalhais"},{"email":"developers@appliedblockchain.com","name":"ab-ci"},{"email":"andycampbell92@gmail.com","name":"andycampbell92"},{"email":"mirek@me.com","name":"mirek"},{"email":"danielmelo@appliedblockchain.com","name":"danchmelo"},{"email":"sereno.rui@gmail.com","name":"ruisereno"},{"email":"ricardo.seromenho@gmail.com","name":"seromenho"},{"email":"ricardo.rocha.pinheiro@gmail.com","name":"kennypt"},{"email":"filipe.pedro@appliedblockchain.com","name":"filipepedro"},{"email":"mario.nikolaus@gmail.com","name":"mnikolaus"},{"email":"nilson@appliedblockchain.com","name":"bertola"},{"email":"joao.luis.achada.lima@gmail.com","name":"lslima91"},{"email":"junior_erico@hotmail.com","name":"juniorerico"},{"email":"alisson@appliedblockchain.com","name":"alisson-diniz-ab"},{"email":"arash.kafaeilotfie@gmail.com","name":"losceicco"},{"email":"gabriels@hey.com","name":"gabspeck"},{"email":"zeljko.tadic.91@gmail.com","name":"ztadic91"},{"email":"ioannis.martakis@appliedblockchain.com","name":"kjack83"},{"email":"andre.faria@appliedblockchain.com","name":"andremfaria"},{"email":"tiagorvmartins@gmail.com","name":"tiagorvmartins"},{"email":"samuelfcmc@gmail.com","name":"samfcmc"},{"email":"bruno.neves@appliedblockchain.com","name":"brunoneves-devops"},{"email":"ewan.sims@appliedblockchain.com","name":"ewan-sims-applied-blockchain"},{"email":"geoffrey.chalk@appliedblockchain.com","name":"geoffreychalk"},{"email":"greg@appliedblockchain.com","name":"grzegorzjucha"},{"email":"tudor@appliedblockchain.com","name":"tudorab"}],"readme":"# Adonis Kue Provider\n\nA [Kue](https://github.com/Automattic/kue) provider for the Adonis framework.\n\nThis library provides an easy way to get started with an asynchronous job queue for AdonisJS.\n\n## Install\n\n```\nnpm install --save adonis-kue\n```\n\n## Configure\n\nRegister the kue provider in `start/app.js`:\n\n```javascript\nconst providers = [\n  ...\n  'adonis-kue/providers/KueProvider'\n]\n```\n\nRegister the commands provider in `start/app.js`:\n\n```javascript\nconst aceProviders = [\n  ...\n  'adonis-kue/providers/CommandsProvider'\n]\n```\n\nRegister the jobs in `start/app.js`:\n\n```javascript\nconst jobs = [\n  ...\n  'App/Jobs/Example'\n]\n```\n\nAdd a configuration file in `config/kue.js`. For example:\n\n```javascript\n'use strict'\n\nconst Env = use('Env')\n\nmodule.exports = {\n  // redis connection\n  connection: Env.get('KUE_CONNECTION', 'kue')\n}\n```\n\n## Usage\n\n### Starting the listener\n\nStarting an instance of the kue listener is easy with the included ace command. Simply run `./ace kue:listen`.\n\n### Creating your first job\n\nThey expose the following properties:\n\n| Name        | Required | Type      | Static | Description                                           |\n|-------------|----------|-----------|--------|-------------------------------------------------------|\n| concurrency | false    | number    | true   | The number of concurrent jobs the handler will accept |\n| key         | true     | string    | true   | A unique key for this job                             |\n| handle      | true     | function  | false  | A function that is called for this job.               |\n\n[Here's an example.](examples/app/Jobs/Example.js)\n\n### Dispatching jobs\n\nNow that your job listener is running and ready to do some asynchronous work, you can start dispatching jobs.\n\n```javascript\nconst kue = use('Kue')\nconst Job = use('App/Jobs/Example')\nconst data = { test: 'data' } // Data to be passed to job handle\nconst priority = 'normal' // Priority of job, can be low, normal, medium, high or critical\nconst attempts = 1 // Number of times to attempt job if it fails\nconst remove = true // Should jobs be automatically removed on completion\nconst job = kue.dispatch(Job.key, data, priority, attempts, remove)\n\n// If you want to wait on the result, you can do this\nconst result = await job.result\n```\n\n## Thanks\n\nSpecial thanks to the creator(s) of [AdonisJS](http://adonisjs.com/) for creating such a great framework.\n","readmeFilename":"README.md"}