Lup-id-amqp-beta NPM

lup-id-amqp-beta

lup-id-amqp-beta est une bibliothèque TypeScript qui fournit une interface pour interagir avec des brokers AMQP (Advanced Message Queuing Protocol) en utilisant la bibliothèque amqplib.

Installation

npm i lup-id-amqp-beta
# or
yarn add lup-id-amqp-beta

Configuration

La bibliothèque expose une fonction config qui peut être utilisée pour configurer les options de connexion AMQP. La fonction prend un objet d'options de configuration facultatif qui peut inclure les propriétés suivantes:

hostname: l'hôte à utiliser pour la connexion AMQP. (défaut: 'localhost') port: le port à utiliser pour la connexion AMQP. (défaut: 5672) username: le nom d'utilisateur à utiliser pour la connexion AMQP. (défaut: 'guest') password: le mot de passe à utiliser pour la connexion AMQP. (défaut: 'guest') vhost: le vhost à utiliser pour la connexion AMQP. (défaut: '') heartbeat: l'intervalle en secondes pour envoyer une impulsion de battement à la connexion AMQP. (défaut: 60) La fonction config renvoie un objet de configuration avec les propriétés suivantes:

hostname: l'hôte utilisé pour la connexion AMQP.
port: le port utilisé pour la connexion AMQP.
username: le nom d'utilisateur utilisé pour la connexion AMQP.
password: le mot de passe utilisé pour la connexion AMQP.
vhost: le vhost utilisé pour la connexion AMQP.
heartbeat: l'intervalle en secondes pour envoyer une impulsion de battement à la connexion AMQP.
protocol: le protocole utilisé pour la connexion AMQP.

La fonction config renvoie un objet de configuration avec les propriétés suivantes:

hostname: l'hôte utilisé pour la connexion AMQP.
port: le port utilisé pour la connexion AMQP.
username: le nom d'utilisateur utilisé pour la connexion AMQP.
password: le mot de passe utilisé pour la connexion AMQP.
vhost: le vhost utilisé pour la connexion AMQP.
heartbeat: l'intervalle en secondes pour envoyer une impulsion de battement à la connexion AMQP.
protocol: le protocole utilisé pour la connexion AMQP.

Utilisation

La bibliothèque expose deux fonctions principales:

createConnection La fonction createConnection crée une connexion AMQP en utilisant les options de configuration spécifiées.

import { createConnection } from 'lup-id-amqp-beta';

const connection = await createConnection();

La fonction renvoie une promesse qui résout avec un objet Connection de amqplib.

sendMessage La fonction sendMessage envoie un message à un broker AMQP en utilisant une connexion AMQP existante.

import { sendMessage } from 'lup-id-amqp-beta';

const messageOptions = {
  exchange: 'myExchange',
  routingKey: 'myRoutingKey',
  message: { hello: 'world' },
};

sendMessage(messageOptions, connection);

La fonction prend deux arguments: un objet SendMessageOptions contenant les options du message à envoyer et une connexion AMQP créée à l'aide de createConnection. La fonction ne renvoie pas de résultat.