web-event-emitter

EventEmitter

This is an implementation of the EventEmitter class that can be used on web projects as a dependency, based on the Node.js EventEmitter documentation.

Table of contents

• Installing
• Importing
• Using
• Testing
• License

Installing

To install this project via NPM (make sure you have Node.js installed):

$ npm install web-event-emitter --save

Importing

In order to use it in your web project, add as a script:

<script src="./node_modules/web-event-emitter/src/EventEmitter.js"></script>

Now, the EventEmitter class will be visible in the global scope.

These builds are available at the moment:

• src/EventEmitter.js: Original ES6 code (not minified)
• dist/eventemitter.es5.js: Transpiled ES5 code (not minified)
• dist/eventemitter.es5.min.js: Transpiled ES5 code (minified)

Using

Creating a new instance

let ee = new EventEmitter();

This will create a new event emitter, so you can use it to register or emit events.

Registering a listener

Registering a new listener for the 'my-event' event:

ee.on('my-event', function(arg1, arg2){
   console.log('\'My event\' has been emitted:');
   console.log(arg1);
   console.log(arg2);
});

You can have as many arguments in your listener as you want.

Emitting an event

Now, if you emit the event:

ee.emit('my-event', 'Hello', 'World');

The output will be:

'My event' has been emitted:
Hello
World

Testing

If you want to run the tests (on Windows):

$ npm test

This will open the HTML test page located in ./test/test.html. You can also open it manually if you want.

License

MIT