Needlessly Promiscuous, Modularize!
Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

amqp-model

2.2.3 • Public • Published

Class based on amqp package for simple publishing and subscribing messages from amqp protocol (RabbitMQ etc.).

Instalation

npm i --save amqp-model

Usage

import AmqpModel from 'amqp-model';
 
const model = new AmqpModel({
    connection: { url: 'amqp://guest:guest@127.0.0.1:5672' },
    queueName: 'queue',
    exchangeName: 'exchange',
    bind: true,
    onReady: () => {
        console.log ('I am connected');
    },
    onError: (err) => {
        console.log(err);
    }
});
 
 
model.publish({
    whatToDo: 'Profit!'
});
 
model.queueByOne((message) => {
    console.log(message);
});

Config parameters

  • connection
    • Connection parameters (link) or instance of connection
  • exchangeOptions
    • Exchange connect options (link)
  • queueOptions
    • Queue connect options (link)
  • subscribeOptions
    • Queue subscribe options (link)
  • queueName
    • Name of your queue
  • exchangeName
    • Name of your exchange
  • bind
    • Initialize bind between queue and exchange
  • onReady
    • It's called when connection is stable.
    • You should connect you subscribe or publish event after this is called
  • onError
    • It's called after every error. Error is in first parameter.
  • routingKey
  • publishOptions
    • Default publish options. You can define other when you call publish method.

Methods

  • .publish(message, options = {}, routingKey = [Routing key in config])
    • Publish message to exchange (should be JSON)
    • If it's called before connection to server is stable, it will be handle after that.
    • Return Promise
      • If exchange hase confirm option on, it's waiting after delivery is confirmed, otherwise it's instant.
  • .queueByOne(fn, subscribeOptions = {})
    • Subscribe to queue and call function in first parameter with message and callback for step to next message.
    • If it's called before connection to server is stable, it will be handle after that.
    • Return Promise
      • Call resolve with consumer tag in argument (it can be handled for unsubscribe only one subscription)
      • Reject is never called.
  • .unsubscribe(consumerTag)
    • Unsubscribe one subscription.
    • Return Promise
      • Resolve is called after success and reject is never called.
  • .unsubscribeAll()
    • Unsubscribe all subscriptions.
    • Return Promise
      • Resolve is called after success and reject is never called.

Using one connection to multiple models

Sometimes you need multiple amqp models connected to one server but you don't wanna initialize multiple connections.

Solution is simple. You create connection separately and then pass it as connection parameter in model initialization.

import amqp from 'amqp';
import AmqpModel from 'amqp-model';
 
const connection = amqp.createConnection({
    url: 'amqp://guest:guest@127.0.0.1:5672'
});
 
const modelOne = new AmqpModel({
    connection,
    ...
});
 
const modelTwo = new AmqpModel({
    connection,
    ...
})

install

npm i amqp-model

Downloadsweekly downloads

106

version

2.2.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability