Skip to content

tomyitav/redis-messaging-manager

Repository files navigation

redis-messaging-manager

Build Status npm MIT licensed code style: prettier semantic-release renovate-app badge

A super simple, instant pubsub messaging library, using

Background

redis-messaging-manager is designed to help you implement a pubsub messaging protocol between your systems services. After installing the library as a dependency, simply use the PubsubManager object provided by the library to setup a connection to a redis broker instance. The two core functions for messaging are publish and consume

Creating PubsubManager instance

  import {PubsubManager} from 'redis-messaging-manager';
  
  let messenger = new PubsubManager({
      host: 'localhost'
  });
  export default messenger;

Additional parameters can be passed to the instance, such as the broker port, and reconnect strategy (Defaults to reconnecting).

Examples for usage

Examples for using the library are provided here

Out of the box features

  • consume method returns an Rx Observable for convenient event processing
  • Server events can be subscribed to by using getServerEventStream method
  • Auto reconnect to the server is implemented in case of broker failure
  • Options to PubsubManager instance can be passed for alternative config

Extended documentation

Please check out the extended documentation for more information