https://github.com/denosaurs/event

📆 Strictly typed event emitter with asynciterator support
https://github.com/denosaurs/event

asynciterator deno event-emitter events hacktoberfest typed

Last synced: 11 days ago
JSON representation

📆 Strictly typed event emitter with asynciterator support

• Host: GitHub
• URL: https://github.com/denosaurs/event
• Owner: denosaurs
• License: mit
• Created: 2020-09-10T21:48:00.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-03T20:43:43.000Z (11 months ago)
• Last Synced: 2024-04-14T00:49:18.400Z (9 months ago)
• Topics: asynciterator, deno, event-emitter, events, hacktoberfest, typed
• Language: TypeScript
• Homepage: https://deno.land/x/event
• Size: 51.8 KB
• Stars: 40
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# event

[![Tags](https://img.shields.io/github/release/denosaurs/event)](https://github.com/denosaurs/event/releases)

[![CI Status](https://img.shields.io/github/workflow/status/denosaurs/event/check)](https://github.com/denosaurs/event/actions)

[![Dependencies](https://img.shields.io/github/workflow/status/denosaurs/event/depsbot?label=dependencies)](https://github.com/denosaurs/depsbot)

[![License](https://img.shields.io/github/license/denosaurs/event)](https://github.com/denosaurs/event/blob/master/LICENSE)

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.

---

```ts

type Events = {

  foo: [string];

  bar: [number, boolean];

};

class MyClass extends EventEmitter {}

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](https://github.com/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.