1.0.15 • Published 4 years ago

@north-tec/nt-amqp v1.0.15

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

npm version npm downloads install size

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

Kind: global class
Extends: events

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

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

ParamTypeDefaultDescription
queueStringThe name of the queue
consumeOptObject{noAck:false}description
queueAssertOptObject{}description
exchangeStringdescription
excangeTypeString"topic"description
exchangeAssertOptObject{}description
routingKeyStringdescription
requeueBooleanfalsedescription

receiver.ack(msg)

Kind: instance method of Receiver

ParamTypeDescription
msgConsumeMessagedescription

receiver.nack(msg, requeue)

Kind: instance method of Receiver

ParamTypeDefaultDescription
msgConsumeMessagedescription
requeueBooleanfalseIf true the message get requeued

Transmitter ⇐ events

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

transmitter.waitForConfirms() ⇒ Promise.<void>

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

transmitter.send(queue, msg, options)

Kind: instance method of Transmitter

ParamTypeDefaultDescription
queueStringQueue name
msgString | ObjectMessage
optionsObject{}Send options

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

Kind: instance method of Transmitter

ParamTypeDefaultDescription
exchangeStringExchange name
routingKeyStringRouting key
msgString | ObjectMessage
optionsObject{}Publish options

Amqp ⇐ events

Kind: global class
Extends: events

Resources

License

1.0.15

4 years ago

1.0.14

5 years ago

1.0.13

5 years ago