https://github.com/tsui66/egg-rabbitmq
amqp plugin for eggjs
https://github.com/tsui66/egg-rabbitmq
amqp egg-amqp egg-amqplib egg-plugin egg-rabbitmq eggjs rabbitmq
Last synced: 9 months ago
JSON representation
amqp plugin for eggjs
- Host: GitHub
- URL: https://github.com/tsui66/egg-rabbitmq
- Owner: tsui66
- License: mit
- Created: 2018-03-10T08:56:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T03:28:59.000Z (over 3 years ago)
- Last Synced: 2025-08-17T12:36:27.479Z (10 months ago)
- Topics: amqp, egg-amqp, egg-amqplib, egg-plugin, egg-rabbitmq, eggjs, rabbitmq
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# egg-rabbitmq
[![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-rabbitmq.svg?style=flat-square
[travis-image]: https://img.shields.io/travis/Quinton/egg-rabbitmq.svg?style=flat-square
[travis-url]: https://travis-ci.org/Quinton/egg-rabbitmq
[codecov-image]: https://img.shields.io/codecov/c/github/Quinton/egg-rabbitmq.svg?style=flat-square
[codecov-url]: https://codecov.io/github/Quinton/egg-rabbitmq?branch=master
[david-image]: https://img.shields.io/david/Quinton/egg-rabbitmq.svg?style=flat-square
[david-url]: https://david-dm.org/Quinton/egg-rabbitmq
[snyk-image]: https://snyk.io/test/npm/egg-rabbitmq/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-rabbitmq
[download-image]: https://img.shields.io/npm/dm/egg-rabbitmq.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-rabbitmq
## 依赖说明
### 依赖的 egg 版本
egg-rabbitmq 版本 | egg 1.x
--- | ---
1.x | 😁
0.x | ❌
### 依赖的插件
## 开启插件
```js
// config/plugin.js
exports.rabbitmq = {
enable: true,
package: 'egg-rabbitmq',
};
```
## 使用场景
- Why and What: 描述为什么会有这个插件，它主要在完成一件什么事情。
尽可能描述详细。
- How: 描述这个插件是怎样使用的，具体的示例代码，甚至提供一个完整的示例，并给出链接。
## 目录结构 &
```
.
├── app
│ ├── schedule
│ │ └── comsumer.js
│ └── router.js
```
## 消费者
```
// /app/schedule/comsumer.js
module.exports = app => {
return {
schedule: {
type: 'rabbitmq', // 扩展定时任务类型, 具体参考 [Egg.js Schedule](https://Quinton.org/zh-cn/basics/schedule.html#%E6%89%A9%E5%B1%95%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1%E7%B1%BB%E5%9E%8B)
worker: 'one',
exchange: 'workflowNewExchange', // MQ exchange
queue: 'workflowNewQueue', // 队列名
},
// schedule 就是上面的 schedule
async task(ctx, { schedule: { queueName }, msg, ackEvent }) {
// do something stuff
},
};
};
```
## 详细配置
请到 [config/config.default.js](config/config.default.js) 查看详细配置项说明。
## 单元测试
## 提问交流
请到 [egg issues](https://github.com/Quinton/egg/issues) 异步交流。
## License
[MIT](LICENSE)