SimpleExternalRabbitMQ

This server-side API class is intended to generate and send messages to an external queue based on RabbitMQ.

getErrors()

If a message cannot be sent, this method displays an error message.

Use it to check your script for errors.

Return:

Type	Description
Array	Error value.

Example:

getErrors()

const rabbitMq = new SimpleExternalRabbitMQ('nofication-service');

const payload = {
    userIDs: [2344, 7444],
    message: "Hello!"
}

ss.info(rabbitMq.publishMessage('push-notifications', JSON.stringify(payload), {ContentType: "application/json", Headers: {"X-Source": "simple"}}).getErrors());

publishMessage()

This method sends a message to a selected queue.

Maximum message length – 26000 characters.

Parameter(s):

Name

Type

Mandatory

Default value

routingKey

String

Y

N

payload

String

Y

N

options

Object

N

Field	Type	Value
Exchange	string	not set
Mandatory	boolean	false
Immediate	boolean	false
Headers	object	{}
ContentType	string	text/plain
ContentEncoding	string	not set
DeliveryMode	integer	1
Priority	integer	0
CorrelationId	string	not set
ReplyTo	string	not set
Expiration	string	not set
MessageId	string	not set
Timestamp	string	0001-01-01 00:00:00
UserId	string	not set
AppId	string	not set
Type	string	not set

Return:

Type	Description
SimpleExternalRabbitMQ	This method returns an instance of the same class.

Example:

publishMessage()

const rabbitMq = new SimpleExternalRabbitMQ('nofication-service');

const payload = {
    userIDs: [2344, 7444],
    message: "Hello!"
}

ss.info(rabbitMq.publishMessage('push-notifications', JSON.stringify(payload), {ContentType: "application/json", Headers: {"X-Source": "simple"}}).getErrors());

publishMultipleMessages()

This method sends an array of messages to a selected queue.

Maximum message length – 26000 characters.

Parameter(s):

Name

Type

Mandatory

Default value

routingKey

String

Y

N

payloads

Array

Y

N

options

Object

N

Field	Type
Exchange	string	not set
Mandatory	boolean	false
Immediate	boolean	false
Headers	object	{}
ContentType	string	text/plain
ContentEncoding	string	not set
DeliveryMode	integer	1
Priority	integer	0
CorrelationId	string	not set
ReplyTo	string	not set
Expiration	string	not set
MessageId	string	not set
Timestamp	string	0001-01-01 00:00:00
UserId	string	not set
AppId	string	not set
Type	string	not set

Return:

Type	Description
SimpleExternalRabbitMQ	This method returns an instance of the same class.

Example:

publishMultipleMessages()

const rabbitMq = new SimpleExternalRabbitMQ('notification-service');

const messages = [
    {
        userID: 2344,
        message: "Hello, Ivan"
    },
    {
        userID: 7444,
        message: "Hello, Petr"
    }
];

rabbitMq.publishMultipleMessages(
    'push-notifications',
    messages.map(m => JSON.stringify(m)),
    {
        ContentType: "application/json",
        Headers: {
            "X-Source": "simple"
        }
    }
)

ss.info(rabbitMq.getErrors());

Page tree

SimpleExternalRabbitMQ

getErrors()

publishMessage()

publishMultipleMessages()