https://github.com/powerbot15/event-dispatcher
Simple javascript events dispatcher with the jQuery like listeners notation
https://github.com/powerbot15/event-dispatcher
custom-events events-dispatcher javascript-events
Last synced: about 2 months ago
JSON representation
Simple javascript events dispatcher with the jQuery like listeners notation
- Host: GitHub
- URL: https://github.com/powerbot15/event-dispatcher
- Owner: powerbot15
- Created: 2016-02-27T19:16:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-12-21T15:02:04.000Z (over 9 years ago)
- Last Synced: 2026-05-03T11:48:36.956Z (about 2 months ago)
- Topics: custom-events, events-dispatcher, javascript-events
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Events Dispatcher
## Easy handling of the custom logical events
Event dispatcher is a lightweight javascript module for custom events handling in **frontend javascript applications**.
### Installation
In the project directory:
```
npm install events-dispatcher
```
### Usage:
#### HTML:
Fill free to change module path for your own project structure
```HTML
```
#### JavaScript:
```javascript
var dispatcher = new EventsDispatcher();
```
### Interface
**Events dispatcher uses jQuery like events handling notation BUT enables you to pass a custom context to callbacks as `this`**
**_Notice:_** _when_ `context` _is not defined, dispatcher passes_ `window` _or_ `global` _as context to callbacks_
___
```javascript
dispatcher.on( eventName, callback [, context] )
```
```eventName``` - Space separated string with events' names ```'eventA eventB eventC'``` to be listened
```callback``` - Callback to be fired when event triggered
```context``` - Not required argument to be a context of the fired event callback
___
```javascript
dispatcher.once( eventName, callback [, context] )
```
Same as `dispatcher.on()` method but attached callbacks will be fired only once and then destroyed
___
```javascript
dispatcher.deBouncedOn(delay, eventName, callback [, context]);
```
`deBouncedOn` method allows attach to event debounced callbacks. Such callback will be fired only if within `delay` in milliseconds listened `event` was not fired. If event was fired during the delay, timer refreshed and callback waiting when same delay will finish
`delay` - Delay in milliseconds to wait for event firings
`eventName` - Space separated string with events' names `'eventA eventB eventC'` to be listened
`callback` - Callback to be fired after `delay` time from the moment event triggered
`context` - Not required argument to be a context of the fired event callback
___
```javascript
dispatcher.off(eventName [, callback]);
```
`eventName` - Space separated string with events' names `'eventA eventB eventC'`, which callbacks will be removed
`callback` - callback function to detach from event callbacks, if not passed, all callbacks of the event will be removed
___
```javascript
dispatcher.trigger(eventName [, dataArg1, ... , dataArgN]);
```
`trigger()` method fires all attached to event callbacks and debounced callbacks
`eventName` - Space separated string with events' names `'eventA eventB eventC'` to be listened
`dataArg1-dataArgN` - Comma-separated data objects(arrays) to pass as parameters to event callbacks