https://github.com/tomyitav/redis-messaging-manager

Pubsub messaging library, using redis and rxjs
https://github.com/tomyitav/redis-messaging-manager

nodejs pubsub redis redis-client rxjs typescript

Last synced: about 2 months ago
JSON representation

Pubsub messaging library, using redis and rxjs

• Host: GitHub
• URL: https://github.com/tomyitav/redis-messaging-manager
• Owner: tomyitav
• License: mit
• Created: 2018-04-06T23:19:35.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-19T04:07:52.000Z (9 months ago)
• Last Synced: 2024-04-14T10:11:26.114Z (9 months ago)
• Topics: nodejs, pubsub, redis, redis-client, rxjs, typescript
• Language: TypeScript
• Homepage: https://medium.com/@tomyitav/pubsub-messaging-using-redis-and-nodejs-6dd117fd1469
• Size: 933 KB
• Stars: 30
• Watchers: 3
• Forks: 4
• Open Issues: 33
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# redis-messaging-manager

[![Build Status](https://travis-ci.org/tomyitav/redis-messaging-manager.svg?branch=master)](https://travis-ci.org/tomyitav/redis-messaging-manager)

[![npm](https://img.shields.io/npm/v/redis-messaging-manager.svg)](https://www.npmjs.com/package/redis-messaging-manager)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![renovate-app badge][renovate-badge]][renovate-app]

[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg

[renovate-app]: https://renovateapp.com/

A super simple, instant pubsub messaging library, using

 

+ [ioredis library](https://github.com/luin/ioredis)

+ rxjs

+ typescript

### 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

```js

  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](https://github.com/tomyitav/redis-messaging-manager-examples)

### 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](https://tomyitav.github.io/redis-messaging-manager/) for more information