amp-message

What is amp-message?

The amp-message npm package is used for encoding and decoding messages in the Advanced Message Queuing Protocol (AMQP) format. It is particularly useful for applications that need to communicate over message queues, providing a simple and efficient way to handle message serialization and deserialization.

What are amp-message's main functionalities?

Encoding Messages

This feature allows you to encode an array of strings into a buffer that can be sent over a message queue. The `amp.Message` constructor takes an array of strings and the `toBuffer` method converts it into a buffer.

const amp = require('amp-message');
const msg = new amp.Message(['Hello', 'World']);
const buf = msg.toBuffer();
console.log(buf);

Decoding Messages

This feature allows you to decode a buffer back into its original message format. The `amp.Message` constructor can also take a buffer, and the `args` property will contain the decoded message.

const amp = require('amp-message');
const buf = Buffer.from([0, 1, 2, 3, 4, 5]);
const msg = new amp.Message(buf);
console.log(msg.args);

Other packages similar to amp-message

amqplib

The amqplib package is a client for RabbitMQ and other AMQP brokers. It provides more comprehensive functionality for interacting with AMQP servers, including message encoding/decoding, but also connection management, channel management, and more. It is more feature-rich compared to amp-message, which focuses solely on message encoding and decoding.

rhea

The rhea package is a more general AMQP 1.0 client that supports a wide range of AMQP features, including message encoding/decoding, connection handling, and link management. It is more versatile and supports more advanced AMQP features compared to amp-message.

README

amp-message

High level AMP Message implementation for manipulating, encoding and decoding AMP messages.

Installation

$ npm install amp-message

Example

Encoding a message:

var Message = require('amp-message');

var msg = new Message;

console.log(msg.toBuffer());
// => <Buffer 10>

msg.push('foo');
msg.push('bar');
msg.push('baz');
console.log(msg.toBuffer());
// => <Buffer 13 00 05 73 3a 66 6f 6f 00 05 73 3a 62 61 72 00 05 73 3a 62 61 7a>

msg.push({ foo: 'bar' });
console.log(msg.toBuffer());
// => <Buffer 14 00 05 73 3a 66 6f 6f 00 05 73 3a 62 61 72 00 05 73 3a 62 61 7a 00 0f 6a 3a 7b 22 66 6f 6f 22 3a 22 62 61 72 22 7d>

msg.push(new Buffer('image data'));
console.log(msg.toBuffer());
// => <Buffer 15 00 05 73 3a 66 6f 6f 00 05 73 3a 62 61 72 00 05 73 3a 62 61 7a 00 0f 6a 3a 7b 22 66 6f 6f 22 3a 22 62 61 72 22 7d 00 0a 69 6d 61 67 65 20 64 61 74 ... >

Decoding a message:

var Message = require('..');

var msg = new Message;

msg.push('foo')
msg.push({ hello: 'world' })
msg.push(new Buffer('hello'))

var other = new Message(msg.toBuffer());

console.log(other.shift());
console.log(other.shift());
console.log(other.shift());

API

Message

Initialize an empty message.

Message(buffer)

Decode the buffer AMP message to populate the Message.

Message(args)

Initialize a messeage populated with args.

License

MIT