js-signals-factory

Simple factory implementation for js-signals.

npm install js-signals-factory
4 downloads in the last month

js-signals-factory

A small factory implementation for js-signals.

Requirements

This is a simple wrapper to make it even easier to use js-signals.

As expected, you will need to have signals available in your application before using this script.

Usage

The signals factory reduces your signal management to a single point where you can request and retrieve all your signals. Using a signal is as simple as:

Get a simple signal

    var completed = SignalFactory.getSignal();
    completed.add(function () {
        console.log('it is completed!');
    });

Get named signals

    // First register a callback function to your signal
    SignalFactory.getSignal('completed').add(function () {
        console.log('it is completed!');
    });

    SignalFactory.getSignal('completed').dispatch();
    // it is completed!

    // Remove reference by name
    SignalFactory.removeSignal('completed');

Get an array with all signals

    var all = SignalFactory.all();

Remove all used signals

    SignalFactory.clear();
    // All used signals are disposed and gone!

License

Released under the MIT License.

npm loves you