psmitter
v1.0.0
Published
Usefull event emitter for Browser
Downloads
2
Maintainers
fernandops26Readme
Psmitter
An usefull event emitter for the Browser
:runner: Migration
Check migration file to 1.0.0.
:cloud: Install
npm install psmitter --save:fork_and_knife: Usage
You can use this module of many ways:
- By minFile:
<!-- index.html -->
<script src="psmiter.min.js" type="text/javascript"></script>// file.js
let myEmitter = new Psmitter()- By require
// file.js
const Psmitter = require('psmitter').Psmitter
let myEmitter = new Psmitter()- By webpack
Only add just with the others vendors files
// webpack.config.js
var vendors = [
...,
'psmitter'
]// file.js
let myEmitter = new Psmitter():memo: Documentation
on(event | [eventA, eventB], fn)
Register a listener for one or more events
Params
- event | [eventA, eventB] -
string|Array: Event name or array of events names - fn -
function: Callback function
emit(event, data)
Dispatch a event
Params
- event -
string: Event name for dispatch - data -
mixed: Data for send when the event is emitted.
once(event | [eventA, eventB], fn)
Register a listener that will be executed only once
Params
- event | [eventA, eventB] -
string|Array: Event name or array of events names - fn -
function: Callback function
getEvents()
Get a list of event names in the current Psmitter instance
Return
- array : The list of events names
getListeners(event)
Get a listeners list binded to determinate event
Params
- event -
string: Event name
Return
- array : The list of listeners
countListeners(event)
Number of listeners registered to an event
Params
- event -
string: Event name
Return
- number : Number of listeners registered
removeListener(event, fn)
Remove an listener of a determinate event
Params
- event -
string: Event name - fn -
function: Callback function to remove
removeAllListeners(event)
Remove all listeners of a event
Params
- event -
string: Event name
removeLastListener(event)
Remove the last listener of an event
Params
- event -
string: Event name
hasSomeListener(event)
Check if exists almost one listener registered to a event
Params
- event -
string: Event name
Return
- boolean : Return
trueif contains some listener, otherwise returnfalse
:clipboard: Examples
If you need to emit and listen some data
// button[id="message"]
var button = document.getElementById('message')
button.addEventListener('click', function () {
myEmitter.emit('message', 'hello world from Psmitter')
})
myEmitter.on('message', function (data) {
console.log(data)
})If you needs to remove and newly register an listener
index.html
<body>
<input type="button" value="Remove listener" id="removeListener">
<input type="button" value="Register Listener" id="registerListener">
<div id="time"></div>
</body>file.js
var time = document.getElementById('time')
var commonListener = function (data) {
time.innerHTML = data
}
myEmitter.on('time', commonListener)
var removeButton = document.getElementById('removeListener')
removeButton.addEventListener('click', function () {
myEmitter.removeListener('time', commonListener)
})
var registerButton = document.getElementById('registerListener')
registerButton.addEventListener('click', function () {
myEmitter.on('time', commonListener)
})
setInterval(function () {
myEmitter.emit('time', new Date())
}, 1000)
:rocket: How to contribute :smiley:
You have a improvement? or found a bug? See how to contribute
:tada: Where is this library used?
If you are using this library in one of your projects, add it in this list.
proyect name with link(Author) ---> description
:scroll: License
[MIT][license] © [Fernando Palacios]