Add a comment

lib/redis-bus.js

@@ -1,6 +1,14 @@
 const Redis = require('ioredis')
 
+/**
+ * This class extends the EventEmitter to act as a pub/sub message bus,
+ * allowing payloads to be received by one instance of Smee and sent by
+ * others. This allows Smee to be multi-instanced!
+ */
 module.exports = class RedisBus {
+  /**
+   * @param {import('events').EventEmitter} events
+   */
   constructor (events) {
     this.events = events
     this.opts = {
@@ -20,6 +28,9 @@ module.exports = class RedisBus {
     this.sub.on('message', (_, message) => this.emitRemoteEvent(message))
   }
 
+  /**
+   * Emit an even to this machine's in-memory EventEmitter
+   */
   emitLocalEvent (message) {
     const json = JSON.parse(message)
     return this.events.emit(json.channel, json.payload)