Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amqp-node/amqplib
AMQP 0-9-1 library and client for Node.JS
https://github.com/amqp-node/amqplib
amqp amqp-0-9-1 nodejs rabbitmq rabbitmq-client
Last synced: 1 day ago
JSON representation
AMQP 0-9-1 library and client for Node.JS
- Host: GitHub
- URL: https://github.com/amqp-node/amqplib
- Owner: amqp-node
- License: other
- Created: 2013-06-12T02:29:36.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T15:17:38.000Z (6 months ago)
- Last Synced: 2024-10-29T11:22:13.571Z (3 months ago)
- Topics: amqp, amqp-0-9-1, nodejs, rabbitmq, rabbitmq-client
- Language: JavaScript
- Homepage: https://amqp-node.github.io/amqplib/
- Size: 955 KB
- Stars: 3,689
- Watchers: 70
- Forks: 474
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs - amqp - AMQP 0-9-1 library and client for Node.JS.  (Repository / Job Queues)
- awesome-github-star - amqplib - 9-1 library and client for Node.JS | amqp-node | 3524 | (JavaScript)
README
# AMQP 0-9-1 library and client for Node.JS
[](https://www.npmjs.com/package/amqplib)
[](https://www.npmjs.com/package/amqplib)
[](https://github.com/amqp-node/amqplib/actions?query=workflow%3A%22Node.js+CI%22)
[](https://snyk.io/advisor/npm-package/amqplib)
npm install amqplib
* [Change log][changelog]
* [GitHub pages][gh-pages]
* [API reference][gh-pages-apiref]
* [Troubleshooting][gh-pages-trouble]
* [Examples from RabbitMQ tutorials][tutes]
A library for making AMQP 0-9-1 clients for Node.JS, and an AMQP 0-9-1 client for Node.JS v10+.
This library does not implement [AMQP
1.0](https://github.com/amqp-node/amqplib/issues/63) or [AMQP
0-10](https://github.com/amqp-node/amqplib/issues/94).
Project status:
- Expected to work
- Complete high-level and low-level APIs (i.e., all bits of the protocol)
- Stable APIs
- A fair few tests
- Measured test coverage
- Ports of the [RabbitMQ tutorials][rabbitmq-tutes] as [examples][tutes]
- Used in production
Still working on:
- Getting to 100% (or very close to 100%) test coverage
## Callback API example
```javascript
const amqplib = require('amqplib/callback_api');
const queue = 'tasks';
amqplib.connect('amqp://localhost', (err, conn) => {
if (err) throw err;
// Listener
conn.createChannel((err, ch2) => {
if (err) throw err;
ch2.assertQueue(queue);
ch2.consume(queue, (msg) => {
if (msg !== null) {
console.log(msg.content.toString());
ch2.ack(msg);
} else {
console.log('Consumer cancelled by server');
}
});
});
// Sender
conn.createChannel((err, ch1) => {
if (err) throw err;
ch1.assertQueue(queue);
setInterval(() => {
ch1.sendToQueue(queue, Buffer.from('something to do'));
}, 1000);
});
});
```
## Promise/Async API example
```javascript
const amqplib = require('amqplib');
(async () => {
const queue = 'tasks';
const conn = await amqplib.connect('amqp://localhost');
const ch1 = await conn.createChannel();
await ch1.assertQueue(queue);
// Listener
ch1.consume(queue, (msg) => {
if (msg !== null) {
console.log('Received:', msg.content.toString());
ch1.ack(msg);
} else {
console.log('Consumer cancelled by server');
}
});
// Sender
const ch2 = await conn.createChannel();
setInterval(() => {
ch2.sendToQueue(queue, Buffer.from('something to do'));
}, 1000);
})();
```
## Running tests
npm test
To run the tests RabbitMQ is required. Either install it with your package
manager, or use [docker][] to run a RabbitMQ instance.
docker run -d --name amqp.test -p 5672:5672 rabbitmq
If prefer not to run RabbitMQ locally it is also possible to use a
instance of RabbitMQ hosted elsewhere. Use the `URL` environment
variable to configure a different amqp host to connect to. You may
also need to do this if docker is not on localhost; e.g., if it's
running in docker-machine.
One public host is dev.rabbitmq.com:
URL=amqp://dev.rabbitmq.com npm test
**NB** You may experience test failures due to timeouts if using the
dev.rabbitmq.com instance.
You can run it under different versions of Node.JS using [nave][]:
nave use 10 npm test
or run the tests on all supported versions of Node.JS in one go:
make test-all-nodejs
(which also needs `nave` installed, of course).
Lastly, setting the environment variable `LOG_ERRORS` will cause the
tests to output error messages encountered, to the console; this is
really only useful for checking the kind and formatting of the errors.
LOG_ERRORS=true npm test
## Test coverage
make coverage
open file://`pwd`/coverage/lcov-report/index.html
[gh-pages]: https://amqp-node.github.io/amqplib/
[gh-pages-apiref]: https://amqp-node.github.io/amqplib/channel_api.html
[gh-pages-trouble]: https://amqp-node.github.io/amqplib/#troubleshooting
[nave]: https://github.com/isaacs/nave
[tutes]: https://github.com/amqp-node/amqplib/tree/main/examples/tutorials
[rabbitmq-tutes]: http://www.rabbitmq.com/getstarted.html
[changelog]: https://github.com/amqp-node/amqplib/blob/main/CHANGELOG.md
[docker]: https://www.docker.com/