denosaurs / event

📆 Strictly typed event emitter with asynciterator support

event

Strictly typed event emitter with asynciterator support.

Events should be defined as a literal object type where the key is the event name, and the value is a tuple with any amount of elements of any type.

The constructor takes an optional argument which defines the maximum amount of listeners per event, which defaults to 10. If this limit is surpassed, an error is thrown.

---

⚠️ Events must be a type, and can't be an interface due to their design differences.

---

type Events = {
  foo: [string];
  bar: [number, boolean];
};

class MyClass extends EventEmitter<Events> {}
const MyClassInstance = new MyClass();

function listener(num, bool) {}

// add a listener to the bar event
MyClassInstance.on("bar", listener);

// remove a listener from the bar event
MyClassInstance.off("bar", listener);

// remove all listeners from the bar event
MyClassInstance.off("bar");

// remove all listeners from the event emitter
MyClassInstance.off();

// add a one-time listener to the bar event
MyClassInstance.once("bar", listener);

// on, once, and off are chainable
MyClassInstance.on("bar", listener).off("bar", listener);

// emit the bar event with the wanted data
MyClassInstance.emit("bar", 42, true);

// listen to all events with an async iterator
for await (const event of MyClassInstance) {
  if (event.name === "bar") {
    // event.value is of type [number, boolean]
  }
}

// listen to a specific event with an async iterator
for await (const [num, bool] of MyClassInstance.on("bar")) {
}

// removes all listeners and closes async iterators
MyClassInstance.close("bar");

Maintainers

• crowlKats (@crowlKats)

Other

Contribution

Pull request, issues and feedback are very welcome. Code style is formatted with deno fmt and commit messages are done following Conventional Commits spec.

Licence

Copyright 2020-present, the denosaurs team. All rights reserved. MIT license.

event's Issues

@denosaurs/event in JSR

I'm porting my deno.land/x module to JSR. However, while @denosaurs/event name exists, nothing exists in the package.

When does it get pushed to JSR?

mapping for denoland/dnt

Hi, I'm trying to convert my first NodeJS project to deno.

EvenEmiter is a very common NodeJS feature, and I do not know how to convert event usage to NodeJS code with dnt.

Do you know how to do that?

dnt issue

.close() type conflict

Hello!

I'm working on node_http, a Node.js-like HTTP server and I need to implement Server.close() method. However, EventEmitter already contains .close() method.

My suggestion would be renaming .close() to removeAllListeners()

ref: https://nodejs.org/dist/latest-v12.x/docs/api/events.html#events_emitter_removealllisteners_eventname