@itavy/mq-connector

Instalation

npm install @itavy/mq-connector

API

Classes

RabbitMQ

Rabbit MQ interface

Objects

itavy/ierror : object

Functions

getConnector(type, options) ⇒ MqConnector

Instantiate a MQ connector

Typedefs

MqConnector : Object

MqConnectorTypes : Object

RabbitMQ

Rabbit MQ interface
Kind: global class

• RabbitMQ

* [new RabbitMQ(di)](#new_RabbitMQ_new)
* [.close()](#RabbitMQ+close) ⇒ <code>Promise</code>
* [.sendMessage(message, queue, [exchange], [options])](#RabbitMQ+sendMessage) ⇒ <code>Promise</code>
* [.subscribe([queue], consumer, [exchange], [topic], [options])](#RabbitMQ+subscribe) ⇒ <code>Promise</code>

new RabbitMQ(di)

| Param | Type | Description | | --- | --- | --- | | di | Object | required dependencies for RabbitMq interface |

rabbitMQ.close() ⇒ Promise

Close connection to message broker
Kind: instance method of RabbitMQ
Returns: Promise - resolves on succeeded connection
Access: public

rabbitMQ.sendMessage(message, queue, exchange, options) ⇒ Promise

Send message to MQ Broker
Kind: instance method of RabbitMQ
Returns: Promise - resolves on success
Access: public
| Param | Type | Default | Description | | --- | --- | --- | --- | | message | Buffer | | message to be sent | | queue | String | | queue or topic where to send the message | | exchange | String | '' | exchage to be used if topics are used | | options | Object | {} | message options to be used when sending message |

rabbitMQ.subscribe(queue, consumer, exchange, topic, options) ⇒ Promise

Subscribe to a queue or topic
Kind: instance method of RabbitMQ
Returns: Promise - resolves on success
Access: public
| Param | Type | Default | Description | | --- | --- | --- | --- | | queue | String | | queue where to subscribe | | consumer | function | | function to be called when there are messages to be received | | exchange | String | | exchange to be used when topics are used | | topic | String | | topic where the queue is binded | | options | Object | | options for subscription |

itavy/ierror : object

Kind: global namespace

getConnector(type, options) ⇒ MqConnector

Instantiate a MQ connector
Kind: global function
Returns: MqConnector - requested mq connector
| Param | Type | Description | | --- | --- | --- | | type | Symbol | mq connector type | | options | Object | specific mq connector options |

MqConnector : Object

Kind: global typedef
Properties
| Name | Type | | --- | --- | | connect | function | | sendMessage | function | | subscribe | function |

MqConnectorTypes : Object

Kind: global typedef
Properties
| Name | Type | | --- | --- | | RABBITMQ | Symbol |

TODO

• Examples

LICENSE

MIT