global-event

A simple event addon.

How to use

All functions will return the global-event object for chained calls.

on

Adds a listener function to the specified event.

• type

  Name of the event to attach the listener to.

• callback

  Method to be called when the event is emitted.

• [context]

  Context of the callback function. If it doesn't provide, the function will be executed in the global scope.

• [namespace]

  Namespace of the listener.

once

Adds a listener function to the specified event which will be emitted only once.

• type

  Name of the event to attach the listener to.

• callback

  Method to be called when the event is emitted.

• [context]

  Context of the callback function. If it doesn't provide, the function will be executed in the global scope.

• [namespace]

  Namespace of the listener.

emit

• type

  Name of the event you want to add the listeners from.

• [callback]

  The callback which will be called after all listeners run.

• [...arguments]

  Arguments you want to pass to the listener.

off

Removes listener functions of the specified event.

• type

  Name of the event you want to remove the listeners from.

• [namespace]

  Namespace of the listeners you want to remove. If it doesn't provide, the function will remove all the listeners of the specified event.

clear

Remove all the listener functions.

Demo

import { on, once, emit, off, clear } from 'global-event';
 
on(
    'logEvent', 
    (information) => console.log(information, 1), 
    null, 
    'demoSpace'
).
on(
    'logEvent', 
    (information) => console.log(information, 2),
    null,
    'anotherSpace'
);
 
emit('logEvent', 'The information');
// output 'The information 1'
// output 'The information 2'
 
off(
    'logEvent',
    'demoSpace'
).
emit(
    'logEvent',
    'Another information'
);
// output 'Another information 2'
 
off(
    'logEvent'
).
emit(
    'logEvent',
    'Third information'
);
// no output
 
let number1 = 0;
once(
    'addEvent', 
    () => {
        ++number1;
        console.log(number1);
    }
).emit(
    'addEvent'
).emit(
    'addEvent'
);
// output 1
// no output
 
clear();
// all listeners will be removed

TODO

Update

• 2016-07-08

  Fix the bug which will make error when users called once function.

• 2016-07-07

  Add once function.

• 2016-03-08

  Test Travis-CI.

• 2016-03-07 0.3.0

  1. emit function now supports chained calls, and the second parameter of emit changed to callback which will be called after all event listeners be executed.
  2. Added clear function.

• 2016-03-07 0.2.1

  Complete README.md.

• 2016-03-05 0.2.0

  on and off functions now can call in chained.