glue-connectors

glue-connectors is a nodeJS module for dealing with message-brokers (like rabbitmq) and data structure storages (like redis).

Installation

npm install glue-connectors

or

yarn add glue-connectors

Usage

AMQP queueing

import { amqp } from 'glue-connectors'

const { Subscriber, Publisher } = amqp

const subscriber = new Subscriber('AMQP_URL', 'QUEUE_NAME')
subscriber.on('SOME_EVENT_NAME', async (payload) => {
  // process the event message data
  console.log(payload)
})
await subscriber.start()

const publisher = new Publisher('AMQP_URL', 'QUEUE_NAME')
await publisher.start()
await publisher.send({
  eventName: 'SOME_EVENT_NAME',
  payload: 'MESSAGE_STRING_OR_OBJECT',
})

// to stop connections. Emits 'close' event when succeed
await subscriber.stop()
await publisher.stop()

Redis storaging

import { redis } from 'glue-connectors'

const redisClient = new redis.Client('REDIS_SERVER_HOST', REDIS_SERVER_PORT, [REDIS_SERVER_PASSWORD])
await redisClient.store('KEY', 'STRING_OR_OBJECT_VALUE', [SECONDS_UNTIL_EXPIRES])
const STRING_OR_OBJECT_VALUE = await redisClient.retrieve('KEY')

// to close connection. Returns true when succeed
await redisClient.close()

Tests

Initialize the following dockers:

sudo docker run --rm -it --hostname my-rabbit -p 15672:15672 -p 5672:5672 rabbitmq:3-management
sudo docker run --rm -it --name my-redis -p 6379:6379 redis

Then run the tests:

npm run test

or

yarn test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT