/events

Primary LanguageJavaScript

Events

Listen and dispatch events =) Not much else to say.

Installing via NPM

npm install --save-dev thalleshmm/events

Methods

Listen

Parameter Type Optional Description
key string no Events name
fn function no Callback function that will run once event is dispatched

Dispatch

Parameter Type Optional Description
key string no Events name
data * yes Data you want to pass to the event callback

Sample

Simple event callback

import Events from 'thalleshmm-events';

const events = new Events();
events.listen('PLAY', () => { alert('Event fired') });
setTimeout(() => {
    events.dispatch('PLAY');
}, 1000);

Passing data to event callback

import Events from 'thalleshmm-events';

const events = new Events();
events.listen('HELLO_NAME', name => { alert('Hello ' + name); });

const btn = document.querySelector('button');
btn.addEventListener('click', () => {
    events.dispatch('HELLO_NAME', 'John');
});

Licence

The MIT License (MIT)

Copyright (c) 2017 Thalles Higor Mendes Maia

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.