Redis-streams-manager NPM

redis-streams-manager

Easy Redis Streams manager. The manager handles the consumption of multiple Streams, and emits new entries by stream name.

Is an EventEmitter which emits stream entries by stream name
Patches the emitter methods (on, off, etc) to automatically start and stop consumption
Ability to add streams starting from an id, instead of the default $

Extracted from a personal project in which I required an easy way to work with multiple streams.

ioredis is marked as a peer dependency, you'll need to install it yourself.

The code was heavily inspired by BullMQ.

Install

npm i redis-streams-manager

Example

Small and confusing example. See the source code for more information.

import IORedis from 'ioredis'
import StreamsManager, { StreamListener } from 'redis-streams-manager'

const blockingClient = new IORedis()
// manager uses blocking commands,
// so it needs a dedicated Redis connection!
const streams = new StreamsManager(blockingClient, {
  blockingTimeout: 10000, // defaults to 10000ms (10s)
  count: 5 // max entries per stream, optional, default not set
})

// define a listener
const listener: StreamListener = (data, id, name) => {
  // `data` is a key-value object
  // `id` is the stream message id
  // `name` is the stream name
}

// consumption will start automatically
// when using `on` and not started yet
streams.on('myStream', listener)

// consumption will stop automatically
// when using `removeListener` and no remaining listeners
streams.removeListener('myStream', listener)

// manually add one or more streams
// if `id` is omitted, defaults to `$`
streams.add('myStream', { key: 'myStream', id: '$' })

// manually remove one or more streams
streams.remove('myStream')