https://github.com/ali-sdk/ali-ons

Aliyun Open Notification Service Client
https://github.com/ali-sdk/ali-ons

rocketmq rocketmq-client

Last synced: 5 days ago
JSON representation

Aliyun Open Notification Service Client

• Host: GitHub
• URL: https://github.com/ali-sdk/ali-ons
• Owner: ali-sdk
• License: mit
• Created: 2015-11-12T05:17:02.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-07-31T15:53:20.000Z (over 1 year ago)
• Last Synced: 2024-12-20T09:05:25.467Z (14 days ago)
• Topics: rocketmq, rocketmq-client
• Language: JavaScript
• Size: 227 KB
• Stars: 151
• Watchers: 29
• Forks: 43
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
ali-ons

=======

[![NPM version][npm-image]][npm-url]

[![ci-actions][ci-image]][ci-url]

[![David deps][david-image]][david-url]

[npm-image]: https://img.shields.io/npm/v/ali-ons.svg?style=flat-square

[npm-url]: https://npmjs.org/package/ali-ons

[ci-image]: https://github.com/ali-sdk/ali-ons/actions/workflows/ci-actions.yml/badge.svg

[ci-url]: https://github.com/ali-sdk/ali-ons/actions/workflows/ci-actions.yml

[david-image]: https://img.shields.io/david/ali-sdk/ali-ons.svg?style=flat-square

[david-url]: https://david-dm.org/ali-sdk/ali-ons

Aliyun Open Notification Service Client (base on opensource project [RocketMQ](https://rocketmq.apache.org/))

Sub module of [ali-sdk](https://github.com/ali-sdk/ali-sdk).

## Install

```bash

npm install ali-ons --save

```

## Usage

consumer

```js

'use strict';

const httpclient = require('urllib');

const Consumer = require('ali-ons').Consumer;

const consumer = new Consumer({

  httpclient,

  accessKeyId: 'your-accessKeyId',

  accessKeySecret: 'your-AccessKeySecret',

  consumerGroup: 'your-consumer-group',

  // namespace: '', // aliyun namespace support

  // isBroadcast: true,

});

consumer.subscribe(config.topic, '*', async msg => {

  console.log(`receive message, msgId: ${msg.msgId}, body: ${msg.body.toString()}`)

  // return Consumer.ACTION_RETRY; // you can return ACTION_RETRY, then this message will be directly retried

});

consumer.on('error', err => console.log(err));

```

If you want to use sql filter, you can subscribe a topic with a sql expression:

```js

consumer.subscribe(

  config.topic,

  {

    expressionType: 'SQL92',

    subString: 'a is not null'

  },

  async msg => {

    console.log(`receive message, msgId: ${msg.msgId}, body: ${msg.body.toString()}`)

  }

);

```

For more information about sql filter, see: [Filter Messages By SQL92](https://rocketmq.apache.org/rocketmq/filter-messages-by-sql92-in-rocketmq/)

producer

```js

'use strict';

const httpclient = require('urllib');

const Producer = require('ali-ons').Producer;

const Message = require('ali-ons').Message;

const producer = new Producer({

  httpclient,

  accessKeyId: 'your-accessKeyId',

  accessKeySecret: 'your-AccessKeySecret',

  producerGroup: 'your-producer-group',

  // namespace: '', // aliyun namespace support

});

(async () => {

  const msg = new Message('your-topic', // topic

    'TagA', // tag

    'Hello ONS !!! ' // body

  );

  // set Message#keys

  msg.keys = ['key1'];

  // delay consume

  // msg.setStartDeliverTime(Date.now() + 5000);

  const sendResult = await producer.send(msg);

  console.log(sendResult);

})().catch(err => console.error(err))

```

## Secure Keys

Please contact to @gxcsoccer to give you accessKey

- [ons secure data](https://sharelock.io/1/UM02CJiYyhXiZDOn1nhX0iqPqMIQtdwI_T5BY3F-tHs.d8-ycA/01veKH9kgAuFuKCqlVPzGsyPWJ8mQLaKPJjjcB9tpdbvi9L6XQ/IgqDvAdVDMzV9lK2gQzyAj7q-CNk8-1tWrLmdqMV0oJ5qgky40/HgpZyKKDfOGAcyqQ20RUdRgCLRWqF8LUUko0uDl_L-ATNOsi5z/W2bsvBc8tAoqSwNR7u2Sqe6XkNmD98s3UQOK-6T8--VwTbHzcG/dwkHwie3EkGB-TbiMnbRh7_5A-DaOTCtALP3xvl4G0XKxuOriC/2yfuPp7WRucTAoqx2STO5Hv3MZEhh3IXf7YiOQ8pWDDqjLuQSY/_irqzYyeseY9m106ksMUq3-yS_qkBRIuoyL-hHk9ZRhGppsdA5/Dw4Pjg.fmNP3aFkLnvPuhlPRwNcng)

## License

[MIT](LICENSE)