Vento

Vento is a event library that automatically creates event methods. Vento is used to be the super class of a class. You can also simply extend your class with Vento. After this you'll be able to either fire the event from the class itself or from external. You are also able to register to the event internally AND externally. All callbacks will be executed.

I implemented this library because I could not find another library doing this simple stuff. I wrote this code nearly in every project in my company or in private projects, so I outsourced the code from the projects.

The whole source is written in ES2015, so the examples are also written in ES2015 syntax.

Install

npm install vento

Usage

First you have to import Vento to the file you want to use it.

import Vento from 'vento';

Then extend your class with Vento.

class MyClass extends Vento {}

After this you can register new events either in the constructor or somewhere else.

this.addEvent('eventName');

You can also bind an internal method directly to your event.

this.addEvent('eventName', this.eventName);

Then you can register to the event. You can create an internal on function or register from external to your event.

eventName() {
  // do something
}

or

myClass.on('eventName', () => {
  // do something
});

or

myClass.onEventName(() => {
  // do something
});

Thats it... now you can fire your custom created event.

myClass.fireEventName();

or

myClass.fireEventName('some', { data: true });

Full example

import Vento from 'vento';

class MyClass extends Vento {
  constructor() {
    this.addEvent('test', this.test);
  }

  test(data1, data2) {
    console.log('inner notification', data1, data2);
  }
}

const myClass = new MyClass();
myClass.on('test', (data1, data2) => {
  console.log('outter notification bound with on', data1, data2);
});

myClass.onTest((data1, data2) => {
  console.log('outter notification bound with onTest', data1, data2);
});

myClass.fireOnTest('first object', 'second object');

Extend extended class

what? ...

If you have a class that already extends a class... or is extended by a class you should also have the ability to use Vento. So you can just hook Vento in the constructor of your sub class.

class SubClass extends SuperClass {
  constructor() {
    super();
    Vento.extend(this);

    this.addEvent('test');
  }
}

Copyright and license

Code and documentation released under the MIT license.