feat: Added event emitter for any event

Now connection.onAll(listener) will trigger the listener on every event or response. It triggers the
listener before any other listeners so that debug statements will be triggered before any other
possibly faulty listeners.

fix #14

Author: juliuscc

README.md

@@ -25,6 +25,7 @@ A low level Node.js api-wrapper for communicating with HEOS devices. It enables
         -   [connection.write(commandGroup, command[, attributes])](#connectionwritecommandgroup-command-attributes)
         -   [connection.on(event, listener)](#connectiononevent-listener)
         -   [connection.once(event, listener)](#connectiononceevent-listener)
+        -   [connection.onAll(listener)](#connectiononall-listener)
         -   [HeosEvent and HeosResponse](#heosevent-and-heosresponse)
 -   [Documentation](#documentation)
 -   [Contributing](#contributing)
@@ -150,6 +151,12 @@ connection.on({ commandGroup: 'event', command: 'player_volume_changed' }, conso
 
 Exactly like [`connection.on()`](<#connection.on(event,-listener)>) but will only trigger the listener the first time the event happens.
 
+#### connection.onAll(listener)
+
+-   `listener`: (message: [HeosEvent](#HeosEvent-and-HeosResponse) | [HeosResponse](#HeosEvent-and-HeosResponse)) => void
+
+Exactly like [`connection.on()`](<#connection.on(event,-listener)>) but will trigger the listener for every response or event. It is useful for logging or debugging purposes. These listeners are triggered before any other as they can be useful for understanding why other listeners might be faulty.
+
 #### HeosEvent and HeosResponse
 
 The responses to commands are objects like this example:

src/connection/connect.ts

@@ -1,6 +1,10 @@
 import { createConnection, Socket } from 'net'
 import { DEFAULT_PORT } from '../utils/constants'
-import { ResponseEventHandler, HeosEventEmitter } from '../listen/responseEventHandler'
+import {
+	ResponseEventHandler,
+	HeosEventEmitter,
+	HeosAllEventEmitter
+} from '../listen/responseEventHandler'
 import { ResponseParser } from '../listen/responseParser'
 import { HeosConnection } from './heosConnection'
 import { HeosResponse, HeosEvent } from '../types'
@@ -41,7 +45,9 @@ export function connect(address: string): Promise<HeosConnection> {
 				const once: HeosEventEmitter = (event, listener) =>
 					responseEventHandler.once(event, listener)
 
-				const connection = new HeosConnection(on, once, (message: string) =>
+				const onAll: HeosAllEventEmitter = listener => responseEventHandler.onAll(listener)
+
+				const connection = new HeosConnection(on, once, onAll, (message: string) =>
 					socket.write(message)
 				)
 

src/connection/heosConnection.ts

@@ -1,26 +1,40 @@
-import { HeosEventEmitter, HeosConnectionEventEmitter } from '../listen/responseEventHandler'
-import { HeosCommandAttribute } from '../types'
+import {
+	HeosEventEmitter,
+	HeosConnectionEventEmitter,
+	HeosAllEventEmitter,
+	HeosConnectionAllEventEmitter
+} from '../listen/responseEventHandler'
 import { generateHeosCommand } from '../write/heosCommand'
+import { HeosCommandAttribute } from '../types'
 
 export class HeosConnection {
 	constructor(
 		on: HeosEventEmitter,
 		once: HeosEventEmitter,
+		onAll: HeosAllEventEmitter,
 		socketWrite: (message: string) => any
 	) {
 		this.on = (event, listener) => {
 			on(event, listener)
 			return this
 		}
+
 		this.once = (event, listener) => {
 			once(event, listener)
 			return this
 		}
+
+		this.onAll = listener => {
+			onAll(listener)
+			return this
+		}
+
 		this.socketWrite = socketWrite
 	}
 
 	on: HeosConnectionEventEmitter
 	once: HeosConnectionEventEmitter
+	onAll: HeosConnectionAllEventEmitter
 	private socketWrite: (message: string) => any
 
 	write(

src/listen/responseEventHandler.ts

@@ -3,11 +3,19 @@ import { EventEmitter } from 'events'
 import { generateHeosCommandString } from './heosCommand'
 import { HeosConnection } from '../connection/heosConnection'
 
+export type HeosConnectionAllEventEmitter = (
+	listener: (message: HeosResponse | HeosEvent) => void
+) => HeosConnection
+
 export type HeosConnectionEventEmitter = (
 	event: HeosCommand,
 	listener: (message: HeosResponse | HeosEvent) => void
 ) => HeosConnection
 
+export type HeosAllEventEmitter = (
+	listener: (message: HeosResponse | HeosEvent) => void
+) => ResponseEventHandler
+
 export type HeosEventEmitter = (
 	event: HeosCommand,
 	listener: (message: HeosResponse | HeosEvent) => void
@@ -16,12 +24,15 @@ export type HeosEventEmitter = (
 export class ResponseEventHandler {
 	constructor() {
 		this.emitter = new EventEmitter()
+		this.listenersOnAll = []
 	}
 
 	emitter: EventEmitter
+	listenersOnAll: ((message: HeosResponse | HeosEvent) => void)[]
 
 	put(message: HeosResponse | HeosEvent): void {
 		const eventString = generateHeosCommandString(message.heos.command)
+		this.listenersOnAll.forEach(listener => listener(message))
 		this.emitter.emit(eventString, message)
 	}
 
@@ -42,4 +53,9 @@ export class ResponseEventHandler {
 		this.emitter.once(eventString, listener)
 		return this
 	}
+
+	onAll(listener: (message: HeosResponse | HeosEvent) => void): ResponseEventHandler {
+		this.listenersOnAll = [...this.listenersOnAll, listener]
+		return this
+	}
 }