lil'-event
Tiny event bus inspired in Node's EventEmitter
Name | event |
Version | 0.1.3 |
Size | 2 KB / >1 KB (gzipped) |
Environment | Node, Browser |
Installation
Node.js
npm install lil-event
Browser
Via Bower
bower install lil-event
Via Component
component install lil-js/event
Or loading the script remotely
Environments
- Node.js
- Chrome >= 5
- Firefox >= 3
- Safari >= 5
- Opera >= 10
- IE >= 9
Usage
You could fetch de module via require()
if it's available.
Otherwise, global fallback will be used, exposed via lil.Event
var lil =
Basic emitter API
{ var bus = db return bus}
Events subscription
Prototype inheritance
{} Humanprototype = Object Humanprototype { this} Humanprototype { this}
Events subscription
var human = humanhuman
API
Event()
Create a new Event bus
Event#on(event, fn)
Alias: addListener
Return: this
Subscribe to an specific event
Event#once(event, fn)
Alias: addOnceListener
Return: this
Subcribe to an specific event for a once time. After event is emitted, the handler will be flushed from the listeners pool
Event#off(event, fn)
Alias: addListener
Return: this
Unsubscribe an event listener by name and function
Event#emit(event, [ arguments... ])
Alias: fire
Return: this
Fire an event on the current bus
Event#offAll(event)
Alias: removeAllListeners
Return: this
Remove all listeners for the given event name
Event.VERSION
Contributing
Wanna help? Cool! It will be appreciated :)
You must add new test cases for any new feature or refactor you do, always following the same design/code patterns that already exist
Development
Only node.js is required for development
Clone the repository
$ git clone https://github.com/lil-js/event.git && cd event
Install dependencies
$ npm install
Generate browser bundle source
$ make browser
Run tests
$ make test
License
MIT © Tomas Aparicio