Code Monkey home page Code Monkey logo

typed-event-emitter's Introduction

typed-event-emitter

Empower a type-safety of events with a typed event-emitter


Provides an amazing experience of event handling by utilising incredible benefits of types. It requires event-to-callback-argument map as first generic attribute and makes sure that all methods are used correctly.

Usage

1. Define event-name to callback-argument type map

Event name is a string, and callback argument can be any type. Use void if event doesn't require an argument.

type EventsMap = {
  ping: { message: string };
}

2. Instantiate TypedEventEmitter

const emitter = new TypedEventEmitter<EventsMap>();

3. Subscribe to events

emitter.on('ping', (arg) => {
  console.log(`ping: "${arg.message}"`);
});

4. Start emitting events

emitter.emit('ping', { message: 'hello!' });

API

TODO:

[-] Add tests
[-] Add documentation
[-] Publish npm package \

typed-event-emitter's People

Contributors

fadedimon avatar

Stargazers

Mikhail Babynichev avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.