# mqemitter-redis

**Repository Path**: mirrors_vpulim/mqemitter-redis

## Basic Information

- **Project Name**: mqemitter-redis
- **Description**: Redis-powered MQEmitter
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2025-10-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

mqemitter-redis  [![Build Status](https://travis-ci.org/mcollina/mqemitter-redis.png)](https://travis-ci.org/mcollina/mqemitter-redis)
===============

Redis-powered [MQEmitter](http://github.com/mcollina/mqemitter).

See [MQEmitter](http://github.com/mcollina/mqemitter) for the actual
API.

[![js-standard-style](https://raw.githubusercontent.com/feross/standard/master/badge.png)](https://github.com/feross/standard)


Install
-------

```bash
$ npm install mqemitter-redis --save
```

Example
-------

```js
var redis = require('mqemitter-redis')
var mq = redis({
  port: 12345,
  host: '12.34.56.78',
  password: 'my secret',
  db: 4
})
var msg = {
  topic: 'hello world'
  payload: 'or any other fields'
}

mq.on('hello world', function (message, cb) {
  // call callback when you are done
  // do not pass any errors, the emitter cannot handle it.
  cb()
})

// topic is mandatory
mq.emit(msg, function () {
  // emitter will never return an error
})
```

## API

<a name="constructor"></a>
### MQEmitterRedis([opts])

Creates a new instance of mqemitter-redis.
It takes all the same options of [ioredis](http://npm.im/ioredis),
which is used internally to connect to Redis.

This constructor creates two connections to Redis.

Alternatively, you can pass in an externally created Redis connection using the
`conn` option. This can be useful when connecting to a Redis cluster, for example.

Example:

```js
var redis = require('mqemitter-redis')
var Redis = require('ioredis')
var mq = redis({
  conn: new Redis.Cluster([{
    port: 6379,
    host: '127.0.0.1'
  }, {
    port: 6380,
    host: '127.0.0.1'
  }])
})
```

Acknowledgements
----------------

Code ported from [Ascoltatori](http://github.com/mcollina/ascoltatori).

License
-------

MIT