AMQP 0-9-1 client, both for browsers (WebSocket) and node (TCP Socket)
npm install @cloudamqp/amqp-clientAMQP 0-9-1 TypeScript client both for Node.js and browsers (using WebSocket). This library is intended to replace all other Node.js AMQP libraries.
This library is Promise-based and hence works very well with async/await. It's secure by default, for instance, publishes aren't fulfilled until either the data has been sent on the wire (so that back propagation is respected), or if the channel has Publish Confirms enabled, it isn't fulfilled until the server has acknowledged that the message has been enqueued.
The library was developed so to make it easy for developers who already are familiar with AMQP to write browser apps that communicates directly with an AMQP server over WebSocket.
The library is developed and supported by CloudAMQP, the largest hosted RabbitMQ provider in the world.
``shell`
npm install @cloudamqp/amqp-client --save
Start node with --enable-source-maps to get proper stacktraces as the library is transpiled from TypeScript.
Using AMQP in Node.js:
`javascript
import { AMQPClient } from "@cloudamqp/amqp-client"
async function run() {
try {
const amqp = new AMQPClient("amqp://localhost")
const conn = await amqp.connect()
const ch = await conn.channel()
const q = await ch.queue()
const consumer = await q.subscribe({ noAck: true }, async (msg) => {
console.log(msg.bodyToString())
await consumer.cancel()
})
await q.publish("Hello World", { deliveryMode: 2 })
await consumer.wait() // will block until consumer is canceled or throw an error if server closed channel/connection
await conn.close()
} catch (e) {
console.error("ERROR", e)
e.connection.close()
setTimeout(run, 1000) // will try to reconnect in 1s
}
}
run()
`
As an alternative to the callback-based approach, you can use an AsyncGenerator for a more modern, iteration-based API:
`javascript
import { AMQPClient } from "@cloudamqp/amqp-client"
async function run() {
try {
const amqp = new AMQPClient("amqp://localhost")
const conn = await amqp.connect()
const ch = await conn.channel()
const q = await ch.queue()
await q.publish("Hello World", { deliveryMode: 2 })
// Subscribe without a callback and use consumer.messages for AsyncGenerator
const consumer = await q.subscribe({ noAck: false })
for await (const msg of consumer.messages) {
console.log(msg.bodyToString())
await msg.ack()
break // breaking automatically cancels the consumer
}
await conn.close()
} catch (e) {
console.error("ERROR", e)
e.connection.close()
}
}
run()
`
This library can be used in the browser to access an AMQP server over WebSockets. For servers such as RabbitMQ that doesn't support WebSockets natively a WebSocket TCP relay have to be used as a proxy. All CloudAMQP servers has this proxy configured. More information can be found in this blog post.
For web browsers a compiled and rolled up version is available at
Using AMQP over WebSockets in a browser:
`html`
Messages with a 1-byte body, no properties:
| Client | Publish rate | Consume rate |
| -------------- | -------------- | -------------- |
| amqp-client.js | 300.000 msgs/s | 512.000 msgs/s |
| amqplib | 172.000 msgs/s | 519.000 msgs/s |
Messages with a 1-byte body, and all properties, except headers:
| Client | Publish rate | Consume rate |
| -------------- | -------------- | -------------- |
| amqp-client.js | 144.000 msgs/s | 202.000 msgs/s |
| amqplib | 110.000 msgs/s | 251.000 msgs/s |
Messages with a 1-byte body, and all properties, including headers:
| Client | Publish rate | Consume rate |
| -------------- | ------------- | ------------- |
| amqp-client.js | 70.000 msgs/s | 89.000 msgs/s |
| amqplib | 60.000 msgs/s | 99.000 msgs/s |
The reason amqp-client is somewhat slower to consume is that to maintain browser compatibility for the websocket client, DataView are used for parsing the binary protocol instead of Buffer.
Module comparison
| Client | Runtime dependencies | Lines of code |
| -------------- | -------------------- | ------------------------------------------------- |
| amqp-client.js | 0 | 1743 |
| amqplib | 14 | 6720 (w/o dependencies) |
This project uses automated release scripts for version management.
The package.json includes several npm scripts for releasing:
- npm run release - Performs a patch version bump (e.g., 3.2.1 → 3.2.2) and creates a release
- npm run release:minor - Performs a minor version bump (e.g., 3.2.1 → 3.3.0) and creates a release
- npm run release:major - Performs a major version bump (e.g., 3.2.1 → 4.0.0) and creates a release
1. Tests: All tests are run to ensure everything passes (preversion)package.json
2. Version bump: npm automatically updates the version in
3. File updates: The version is updated in , code is formatted, and changelog is updated (version)version
4. Staging: All changes are staged for commit ()postversion
5. Git commit: npm automatically commits all staged changes with a version message
6. Git tag: An annotated tag is created with the full changelog content as the tag message ()postversion
7. Push: Both the commit and tags are pushed to the remote repository ()
8. CI deployment: The GitHub Actions workflow automatically publishes the new version to npm
> Technical Note: This release process leverages npm's built-in version lifecycle hooks (preversion, version, postversion). The npm version command automatically handles the git commit after running our custom version script, which is why we stage changes with git add -A rather than committing manually.
Before releasing:
1. Add your changes to the ## [Unreleased] section in CHANGELOG.md
2. All tests should pass ()
3. The working directory should be clean (no uncommitted changes)
When a new tag is pushed (e.g., v3.3.0), the GitHub Actions workflow (.github/workflows/release.yml`) automatically:
- Builds the project
- Publishes the package to npm with public access and provenance
- Creates a GitHub release with browser bundle artifacts
The git tag contains the complete changelog section for that version, including version header, all changes, and PR links. This makes it easy to see what changed in each release directly from the git tag.