# egg-delayed-job

> A priority job queue backed by redis, built for eggjs.

Latest version **1.0.0** (published 2017-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-delayed-job
pnpm add egg-delayed-job
yarn add egg-delayed-job
bun add egg-delayed-job
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-07-15 |
| First published | 2017-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Justin-lu |
| Maintainers | justin_lu |
| Keywords | egg, eggPlugin, egg-plugin, delayed-job |

## Links

- npm: https://www.npmjs.com/package/egg-delayed-job
- Repository: https://github.com/Justin-lu/egg-delayed-job
- Homepage: https://github.com/Justin-lu/egg-delayed-job#readme
- Issues: https://github.com/Justin-lu/egg-delayed-job/issues
- npm.io page: https://npm.io/package/egg-delayed-job

## Dependencies (1)

- [kue](https://npm.io/package/kue.md) ^0.11.6

## Alternatives

- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-07-15

## README

# egg-delayed-job

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-delayed-job.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-delayed-job
[travis-image]: https://img.shields.io/travis/eggjs/egg-delayed-job.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-delayed-job
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-delayed-job.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-delayed-job?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-delayed-job.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-delayed-job
[snyk-image]: https://snyk.io/test/npm/egg-delayed-job/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-delayed-job
[download-image]: https://img.shields.io/npm/dm/egg-delayed-job.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-delayed-job

A priority job queue backed by redis, built for eggjs.

## Install

```bash
$ npm i egg-delayed-job --save
```

## Usage

```js
// {app_root}/config/plugin.js
exports.delayedJob = {
  enable: true,
  package: 'egg-delayed-job',
};
```

## Configuration

```js
// {app_root}/config/config.default.js
'use strict';
exports.delayedJob = {
  client: {
    queuePrefix: 'q',
    redis: {
      port: 6379,
      host: '127.0.0.1',
      auth: '',
      db: 3,
      // see https://github.com/mranney/node_redis#rediscreateclient
      options: {
      },
    },
  },
  // clients: {}
};
```

see [config/config.default.js](config/config.default.js) for more detail.

## Example

```js
app.delayedJob.process('email', (job, done) => {
  // send email for this;
  email(job.data.to, done);
});

app.delayedJob.create('email', {
    title: 'welcome email for justin'
  , to: 'gdjyluxiaoyong@gmail.com'
  , template: 'welcome-email'
}).save();
```

form more config please see [here](https://github.com/Automattic/kue)

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/egg-delayed-job · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._