EventEmitter

EventEmitter

new EventEmitter()

Source:

Very simple event emitter implementation.

Example
const ee = EventEmitter()

ee.on('myEvent', (e) => {
  console.log(e.foo);
})

ee.emit('myEvent', {
   foo: 'bar',
}) // prints `bar` in the console

Members

(private) _events :Object

Source:

Object with registered event listeners. Keys are event names.

Type:
  • Object

Methods

emit(event, …argopt)

Source:

Emits event. All listeners attached to this event name earlier will be called with arguments passed after event name.

Parameters:
Name Type Attributes Description
event String

event name

arg Any <optional>
<repeatable>

multiple arguments, that will be passed to listeners

off(event, fn)

Source:

Removes listener for event.

Example
const myHandler = (e) => {}
ee.on('myEvent', myHandler) // handler attached
ee.off('myEvent', myHandler) // handler detached
Parameters:
Name Type Description
event String

event name

fn function

listener function attached earlier

on(event, fn, onceopt)

Source:

Method used to register event listener.

Parameters:
Name Type Attributes Default Description
event String

event name

fn function

event listener

once Boolean <optional>
false

if set to true, listener will be called once, then it will be unregistered

once(event, fn)

Source:

Same as EventEmitter#on, bu with implicit once parameter set to true.

Parameters:
Name Type Description
event String

event name

fn function

event listener

startResponding()

Source:

Reenables disabled event emitter.

stopResponding()

Source:

Disables event emitter so it won't repond to any emitted events.