This is a summary. See the amqp-ts Wiki for the full documentation of the library.
Amqp-ts is a library for nodejs that simplifies communication with AMQP message busses written in Typescript. It has been tested on RabbitMQ. It uses the amqplib library by Michael Bridgen (squaremo).
Starting in version 0.14 the return type of exchange.rpc and queue.rpc changed from 'Promise < any >' to 'Promise < Message >'.
Starting in version 0.12 the Message class has been added. It is a more elegant way to send and receive messages. It is the preferred way to deal with sending and receiving messages.
- [High level non opinioned library], no need to worry about channels etc.
- 'Lazy' initialization, async AMQP dependencies are resolved automatically
- Automatic reconnection, when the connection with the AMQP server fails, the whole connection and configuration is rebuilt automatically
- Written in typescript, it is compatible with the Typescript 1.6 module type definition resolution for node.js.
The library is considered production ready.
It does depend on the following npm libraries:
The DefinitelyTyped tsd tool is used to manage the typescript type definitions.
No need to nest functionality, just create a connection, declare your exchanges, queues and bindings and send and receive messages. The library takes care of any direct dependencies.
If you define an exchange and a queue and bind the queue to the exchange and want to make
sure that the queue is connected to the exchange before you send a message to the exchange you can call the connection.completeConfiguration() method and act on the promise it returns.
import * as Amqp from "amqp-ts";
var connection = new Amqp.Connection("amqp://localhost");
var exchange = connection.declareExchange("ExchangeName");
var queue = connection.declareQueue("QueueName");
queue.bind(exchange);
queue.activateConsumer((message) => {
console.log("Message received: " + message.getContent());
});
// it is possible that the following message is not received because
// it can be sent before the queue, binding or consumer exist
var msg = new Amqp.Message("Test");
exchange.send(msg);
connection.completeConfiguration().then(() => {
// the following message will be received because
// everything you defined earlier for this connection now exists
var msg2 = new Amqp.Message("Test2");
exchange.send(msg2);
});var amqp = require("amqp-ts");
var connection = new amqp.Connection("amqp://localhost");
var exchange = connection.declareExchange("ExchangeName");
var queue = connection.declareQueue("QueueName");
queue.bind(exchange);
queue.activateConsumer((message) => {
console.log("Message received: " + message.getContent());
});
// it is possible that the following message is not received because
// it can be sent before the queue, binding or consumer exist
var msg = new amqp.Message("Test");
exchange.send(msg);
connection.completeConfiguration().then(() => {
// the following message will be received because
// everything you defined earlier for this connection now exists
var msg2 = new amqp.Message("Test2");
exchange.send(msg2);
});More examples can be found in the tutorials directory.
To know the status of the connection: connection.isConnected. Returns true if the connection exists and false, otherwise.
#on('open_connection', function() {...})
It's emitted when a connection is concretized and can publish/subscribe in Rabbit Bus.
#on('close_connection', function() {...})
It's emitted when a connection is closed, after calling the close method.
#on('lost_connection', function() {...})
It is emitted when the connection is lost and before attempting to re-establish the connection.
#on('trying_connect', function() {...})
It is emitted during the time that try re-establish the connection.
#on('re_established_connection', function() {...})
It is emitted when the connection is re-established.
#on('error_connection', function(err) {...})
It's emitted when a error is registered during the connection.
When the library detects that the connection with the AMQP server is lost, it tries to automatically reconnect to the server.
- now you can return a
Promisewithqueue.activateConsumerfor RPC's. The result of the resolvedPromisewill be returned to the RPC caller.
- added
noCreatecreation option property forExchangeandQueue(expects the exchange or queue to already exist in AMQP) - improved unit tests
- added
nameproperty forExchangeandQueueandtypeproperty forExchange - improved consumer cleanup for
ExchangeandQueuemethodscloseanddelete
- added the
prefetchoption toDeclarationOptionsin theamqp-ts.d.tsfile
- fixed incorrect implementation of nack, syntax is now in line with amqplib nack
- fixed bug in automatic reconnect (exponential growth of retries hanging the application)
- updated typescript definition file management from tsd to typings
- added [queue.prefetch](https://github.com/abreits/amqp-ts/wiki/Queue class#prefetch) and [queue.recover](https://github.com/abreits/amqp-ts/wiki/Queue class#recover) methods
- updated to version 1.0 (finally)
- fixed error when using node.js version 0.10.x:
pathlibrary does not have a methodparsein 0.10.x
- improved readability of readme.md on npmjs
- multiple calls of
exchange.close,exchange.delete,queue.closeandqueue.deletereturn the same promise (and are thereby executed only once)
- added extra promise rejection handling for
exchange.close,exchange.delete,queue.closeandqueue.delete
- changed the return type of exchange.rpc and queue.rpc from 'Promise < any >' to 'Promise < Message >'
- added the option to return a Message in exchange.activateConsumer and queue.activateConsumer
- updated the amqp-ts Wiki API documentation
- skipped to avoid bad luck :)
- added Message class
- added exchange.send and queue.send.
- deprecated exchange.publish and queue.publish.
- added exchange.activateConsumer and queue.activateConsumer.
- deprecated exchange.startConsumer and queue.startConsumer.
- changed connection.declareExchange and connection.declareQueue to prevent duplicate declaration of the same exchange/queue
- added connection.declareTopology
- added support functions [getMessageContent] and [setMessageContent]
- fixed bug in integration test
- revised amqp-ts logging, see Logging in the wiki for more details
- fixed bug in tutorials library reference
- added amqp-ts examples for the RabbitMQ tutorials
- fixed a bug in the queue.rpc
- fixed documentation errors
- Moved the documentation to the wiki,only the 'Overview', 'What's new' and 'Roadmap' stay in the readme.md for npmjs and GitHub.
- Improved the documentation
- rearranged this readme
- added rpc support to the Queue and Exchange for RabbitMQ 'direct reply-to' RPC functionality
- updated dependencies
- updated the documentation
- added a 'low level' queue consumer that receives the raw message and can 'ack' or 'nack' these messages itself
- cleanup integration tests
- readme update and fixes
- added close methods to Exchange and Queue
- changed Promise type for Exchange.initialized and Queue.initialized
- minor readme fixes
- improved robustness for unit tests
- small code cleanup: defined optional parameter default values in typescript
- fixed a few bugs when publishing a message to an exchange after a disconnect/reconnect
- Added this section
- Added the roadmap section
- Improved the winston logging messages
The roadmap section describes things that I want to add or change in the (hopefully near) future.
- Better source code documentation, maybe even use jsdoc or tsdoc to generate the api documentation