Typed EventDispatcher

Just a simple strictly typed event dispatcher

Installation

1npm install @keupoz/typed-event-dispatcher

Usage

1import { EventDispatcher } from "@keupoz/typed-event-dispatcher";
2
3// EventDispatcher accepts any type
4// but it should be a record of data types associated with event names
5export interface IFooEvents {
6  init: null;
7  bar: {
8    type: string;
9    data: any;
10  };
11}
12
13export class Foo extends EventDispatcher<IFooEvents> {
14  constructor() {
15    super();
16
17    this.dispatch("init", null);
18  }
19
20  public bar(data: any): void {
21    this.dispatch("bar", {
22      type: "test data",
23      data: data,
24    });
25  }
26}
27
28const foo = new Foo();
29
30// data is null
31foo.on("init", () => {
32  console.log("Foo is initialized");
33});
34
35// data is { type: string; data: any; }
36foo.on("bar", (data) => {
37  console.log(`Got data of type '${data.type}'`, data.data);
38});
39
40foo.bar(["some", "random", "data"]);
41
42// Remove all listeners
43foo.dispose();