@itavy/mq-connector

Interface for mq connectivity for mq-router

Stats

StarsIssuesVersionUpdatedCreatedSize
@itavy/mq-connector
301.0.03 years ago3 years agoMinified + gzip package size for @itavy/mq-connector in KB

Readme

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

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
RABBIT_MQ Symbol

TODO

  • Examples

LICENSE

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.