event-dispatcher

Fully typed event dispatcher.

---

Simple usage example:

Within your class:

1// [1] Define events and payloads
2type ConnectionEvent = {
3    "connect": { id: string, timestamp: number },
4    "disconnect": { id: string, timestamp: number, reason?: string },
5};
6
7// [2] Extend your class
8class Connection extends EventDispatcher<ConnectionEvent> {
9    constructor() { super(); }
10
11    private dispatchDisconnect() {
12        // [3] Call dispatch
13        this.dispatch(
14            "disconnect",
15            { id: "abcdefg", timestamp: 1675644952, reason: "timed out" },
16        );
17    }
18}

From calling code:

1function handleDisconnect(ev: ConnectionEvent["disconnect"]) {
2    console.log("Disconnected:", ev.id, ev.timestamp, ev.reason);
3}
4
5const connection = new Connection();
6
7connection.addEventListener("disconnect", handleDisconnect);

API

Public

• EventDispatcher.addEventListener(name, func)
• EventDispatcher.removeEventListener(name, func)
• EventDispatcher.removeAllEventListeners()

Protected

• EventDispatcher.dispatch(name, payload)