C class

EventBus

A class that can be extended in order to provide it with a custom event channel.

Constructor


new EventBus()

Examples

const object = new EventBus();
object.addEventListener('expand', function(){ alert('expanded'); });
object.dispatchEvent('expand');

Instance Properties


bindedObjects: 
            
                Object.<string, Object>

Object containing references to objects this instance is listening to


eventListeners: 
            
                Object.<string, Array>

Object containing all event listeners


listenerId: 
            
                string

Unique identifier for this event bus instance

Instance Methods


addEventListener(name, callback, options)
    
    
    
        →
        
            
                
                    EventBus

Bind an event to a callback function. Passing "*" will bind the callback to all events fired.

If the options.once is true, the event will only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in as an array, the handler will fire once for each event, not once for a combination of all events.

Parameters

name :


            
                string
                |
            
                Array.<string>
                |
            
                object

Event name(s) or object of event/callback pairs

callback :

Callback function or options object if name is an object

options :


            
                object

optional

Event options

once :


            
                boolean

optional

Whether the event should only trigger once

context :


            
                object

optional

The context to bind the event to

listener :


            
                object

optional

The listener object

Returns


                        
                            EventBus

Returns this for chaining


addEventListenerFor(obj, name, callback, options)
    
    
    
        →
        
            
                
                    EventBus

Tell this object to listen to an event in another object, while keeping track of what it's listening to for easier unbinding later.

Parameters

obj :

The object to listen to events on

name :


            
                string
                |
            
                Array.<string>
                |
            
                object

Event name(s) or object of event/callback pairs

callback :

Callback function or options object if name is an object

options :


            
                object

optional

Event options

once :


            
                boolean

optional

Whether the event should only trigger once

context :


            
                object

optional

The context to bind the event to

Returns


                        
                            EventBus

Returns this for chaining


dispatchEvent(name, args)
    
    
    
        →
        
            
                
                    EventBus

Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as dispatchEvent is, apart from the event name (unless you're listening on "*", which will cause your callback to receive the true name of the event as the first argument).

Parameters

name :


            
                string
                |
            
                Array.<string>

Event name or array of event names

args :

Arguments to pass to the event handlers

Returns


                        
                            EventBus

Returns this for chaining


removeEventListener(name, callback, options)
    
    
    
        →
        
            
                
                    EventBus

Remove one or many callbacks that match the arguments. If called with no arguments, removes all callbacks for all events.

Parameters

name :


            
                string
                |
            
                Array.<string>
                |
            
                object
                |
            
                null

optional

Event name(s) or object of event/callback pairs

callback :

optional

Callback function or options object if name is an object

options :


            
                object

optional

Event options

once :


            
                boolean

optional

Match only events set to trigger once

context :


            
                object

optional

Match only events bound to this context

listener :


            
                object

optional

Match only events bound by this listener

Returns


                        
                            EventBus

Returns this for chaining


removeEventListenerFor(obj, name, callback, options)
    
    
    
        →
        
            
                
                    EventBus

Tell this object to stop listening to either specific events or to every object it's currently listening to.

Parameters

obj :

optional

The object to stop listening to; if omitted, stops listening to all objects

name :


            
                string
                |
            
                Array.<string>
                |
            
                object

optional

Event name(s) or object of event/callback pairs

callback :


            
                function

optional

Callback function to remove

options :


            
                object

optional

Event options

once :


            
                boolean

optional

Match only events set to trigger once

context :


            
                object

optional

Match only events bound to this context

Returns


                        
                            EventBus

Returns this for chaining