Nimoy Prospers Mystically

    hotrod-rabbitmq-sender

    0.2.1 • Public • Published

    hotrod-rabbitmq-sender

    Reliably sends JSON objects to RabbitMQ using confirms

    Install

    npm install hotrod-rabbitmq-sender
    

    Overview

    Provides a RabbitSender class with a single send(payload) function. Uses the amqplib library to do the sending and ensures that the channel used is an instance of the ConfirmChannel from that library.

    The RabbitSender class can be used on it's own but it's recommended to use the senderFactory wrapper which creates all the amqplib types, asserts the queue is present first and detects connection errors.

    Sample Usage

    rabbitMqSenderFactory.create(RABBIT_URL, QUEUE_NAME, onRabbitConnErr, {
        exchange: EXCHANGE,
        routingKey: ROUTING_KEY
    }).then(function(rabbitMsgSender) {
      var payload = { ... };
      rabbitMsgSender.send(payload);
    });
     
    var onRabbitConnErr = function(err) {
        console.log('Connection error:', err);
        // ...
    };

    Also see the manualTester.js file provided for an example of how to configure.

    API

    senderFactory

    senderFactory(url, queueName, connErrHandler, senderOptions, otherOptions)

    • url - RabbitMQ connection URL (something like amqp://guest:guest@localhost:5672)
    • queueName - RabbitMQ queue name
    • connErrHandler connection error callback. May be called initially if a connection can't be established or some time later if connection drops.
    • senderOptions - Options to pass to the RabbitSender class. See below
    • otherOptions -
      • otherOptions.queue - Optional object which can override the default queue options of { durable: true }
      • otherOptions.socket - Optional socket options object which is passed to amqplib.connect(url, socketOptions)

    RabbitSender class

    function RabbitSender(channel, options)

    • channel - Instance of a ConfirmChannel from the amqplib library
    • options
      • options.exchange - RabbitMQ exchange name (or empty string)
      • options.routingKey - RabbitMQ routing key (which is a queue name if exchange is an empty string)
      • options.publish - optional object which can be used to override the default publisher options of { mandatory: true, persistent: true }

    License

    The MIT License (MIT)

    Copyright (c) Panoptix CC

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i hotrod-rabbitmq-sender

    DownloadsWeekly Downloads

    2

    Version

    0.2.1

    License

    MIT

    Last publish

    Collaborators

    • emertechie
    • stephanbuys