@north-tec/nt-amqp

Installing

Using npm:

$ npm install @north-tec/nt-amqp

Example

const Amqp = require('@north-tec/nt-amqp');
const amqpClient = new Amqp();

const connection = {
    "protocol": "amqps",
    "hostname": "broker.address.net",
    "port": 5671,
    "locale": "de_DE",
    "frameMax": 0,
    "heartbeat": 10,
    "username": "dummy",
    "password": "password",
    "vhost": "/dummy"
}

(async () => {
    amqpClient.on('reconnect', () => { process.exit(0) });
    await amqpClient.connect(connection), {}, 100);
    const receiver = amqpClient.Receiver;

    receiver.consume('dummy-queue');

    receiver.on('message', message => {
        console.log(message.content.toString());
    });
})()

Classes

Receiver ⇐ events

Create a new instance of Receiver

Transmitter ⇐ events

Create a new instance of Transmitter

Amqp ⇐ events

Create a new instance of Amqp

Receiver ⇐ events

Create a new instance of Receiver

Kind: global class
Extends: events

• Receiver ⇐ events
  • .consume(queue, consumeOpt, queueAssertOpt, exchange, excangeType, exchangeAssertOpt, routingKey, requeue)
  • .ack(msg)
  • .nack(msg, [requeue])

receiver.consume(queue, consumeOpt, queueAssertOpt, exchange, excangeType, exchangeAssertOpt, routingKey, requeue)

[consume description]

Kind: instance method of Receiver
Emits: Receiver#event:message, Receiver#event:error

Param	Type	Default	Description
queue	String		The name of the queue
consumeOpt	Object	{noAck:false}	[description]
queueAssertOpt	Object	{}	[description]
exchange	String		[description]
excangeType	String	"topic"	[description]
exchangeAssertOpt	Object	{}	[description]
routingKey	String		[description]
requeue	Boolean	false	[description]

receiver.ack(msg)

Acknowledge a message

Kind: instance method of Receiver

Param	Type	Description
msg	ConsumeMessage	[description]

receiver.nack(msg, [requeue])

Not acknowledge a message

Kind: instance method of Receiver

Param	Type	Default	Description
msg	ConsumeMessage		[description]
[requeue]	Boolean	false	If true the message get requeued

Transmitter ⇐ events

Create a new instance of Transmitter

Kind: global class
Extends: events
Emits: Transmitter#event:send, Transmitter#event:error

• Transmitter ⇐ events
  • .waitForConfirms() ⇒ Promise.<void>
  • .send(queue, msg, [options])
  • .publish(exchange, routingKey, msg, [options])

transmitter.waitForConfirms() ⇒ Promise.<void>

Kind: instance method of Transmitter
Returns: Promise.<void> -

[description]

transmitter.send(queue, msg, [options])

Send a message direct to queue

Kind: instance method of Transmitter

Param	Type	Default	Description
queue	String		Queue name
msg	String | Object		Message
[options]	Object	{}	Send options

transmitter.publish(exchange, routingKey, msg, [options])

Publish a message to exchange

Kind: instance method of Transmitter

Param	Type	Default	Description
exchange	String		Exchange name
routingKey	String		Routing key
msg	String | Object		Message
[options]	Object	{}	Publish options

Amqp ⇐ events

Create a new instance of Amqp

Kind: global class
Extends: events

Resources

• Changelog

License

• MIT