# egg-mq-http-sdk

> [![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]][down

Latest version **0.2.0** (published 2020-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-mq-http-sdk
pnpm add egg-mq-http-sdk
yarn add egg-mq-http-sdk
bun add egg-mq-http-sdk
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2020-05-29 |
| First published | 2020-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 1 |
| Unpacked size | 19.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | cuifan53 |
| Maintainers | cuifan53 |
| Keywords | egg, eggPlugin, egg-plugin |

## Links

- npm: https://www.npmjs.com/package/egg-mq-http-sdk
- Repository: https://github.com/cuifan53/egg-mq-http-sdk
- Homepage: https://github.com/cuifan53/egg-mq-http-sdk#readme
- Issues: https://github.com/cuifan53/egg/issues
- npm.io page: https://npm.io/package/egg-mq-http-sdk

## Dependencies (1)

- [@aliyunmq/mq-http-sdk](https://npm.io/package/@aliyunmq/mq-http-sdk.md) ^1.0.2

## Recent versions

- 0.2.0 (latest) — 2020-05-29
- 0.1.9 — 2020-05-29
- 0.1.8 — 2020-05-29
- 0.1.7 — 2020-05-29
- 0.1.6 — 2020-05-29
- 0.1.5 — 2020-05-29
- 0.1.4 — 2020-05-28
- 0.1.3 — 2020-05-28
- 0.1.2 — 2020-05-28
- 0.1.1 — 2020-05-28
- 0.1.0 — 2020-05-28
- 0.0.9 — 2020-05-28
- 0.0.8 — 2020-05-28
- 0.0.7 — 2020-05-28
- 0.0.6 — 2020-05-28
- … 5 more at https://npm.io/package/egg-mq-http-sdk/versions

## README

# egg-mq-http-sdk

[![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-mq-http-sdk.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-mq-http-sdk
[travis-image]: https://img.shields.io/travis/eggjs/egg-mq-http-sdk.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-mq-http-sdk
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-mq-http-sdk.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-mq-http-sdk?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-mq-http-sdk.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-mq-http-sdk
[snyk-image]: https://snyk.io/test/npm/egg-mq-http-sdk/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-mq-http-sdk
[download-image]: https://img.shields.io/npm/dm/egg-mq-http-sdk.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-mq-http-sdk

<!--
Description here.
-->

## Install

```bash
$ npm i egg-mq-http-sdk --save
```

## Usage

```js
// {app_root}/config/plugin.js
exports.mqHttpSdk = {
  enable: true,
  package: 'egg-mq-http-sdk',
};
```

## Configuration

```js
// {app_root}/config/config.default.js
exports.mqHttpSdk = {
  endpoint: '',
  accessKeyId: '',
  accessKeySecret: '',
  securityToken?: '',
  producers?: [{
      instanceId: '',
      topic: '',
      groupId?: '', 
  }],
  consumers?: [{
      instanceId: '',
      topic: '',
      groupId?: '',
      messageTags?: [''], 
  }],
  pollingInterval?: 3000, // 轮询间隔 ms 默认为0
};
```
## Example

```js
import { MQClient, createMessageProperties, ConsumeMessageResponse } from 'egg-mq-http-sdk';

const client: MQClient = (this.app as any).mqClient;

const producer = client.getProducer(instanceId, topic); 
const msgProps = createMessageProperties();
msgProps.messageKey(message_key);
await producer.publishMessage(body, tag, msgProps);

const transProducer = client.getTransProducer(instanceId, topic, groupId);


app.ts:
import { consume, transProduce } from 'egg-mq-http-sdk';

app.beforeStart(async () => {
    consume(app, 'messageTag', async (ctx, consumer, message) => {
      // 注册消费消息方法
    });
    transProduce(app, 'messageTag', async (ctx, transProducer, message) => {
      // 注册回查半消息方法
    })
});
```

## Questions & Suggestions

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

## License

[MIT](LICENSE)

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