EventFilter

EventFilter regulates the broadcasting of events based on a specified condition function of standard event type: function(type, data).

Overview

Options
Methods
emit
trigger

EventFilter(condition)

Constructor Parameters

condition

Function

function to determine whether or not events are emitted.

Methods

emit(type, data)

If filter condition is met, trigger an event, sending to all downstream handlers listening for provided 'type' key.

Parameters
type
String
event type key (for example, 'click')
data
Object
event data
Returns
EventHandler
this

trigger(type, data)

An alias of emit. Trigger determines whether to send events based on the return value of it's condition function when passed the event type and associated data.

Parameters
type
String
name of the event
data
Object
associated data