README

Goals
-----

events4js is a javascript events framework 

designed for require() usage

write by @waxzce

examples and test avaible into the tests directory

API doc is generated by yuidoc into docs/output/pathjs_docs/index.html

build directory contain usable build

feel free to contribute, comment or ask :-)

Under MIT licence 


HOW TO USE
----------

The goal of event4js is give the possibility of produce events from any object.

Create an EventProducer :
__________________________________________________________________________________________
var MyClass = (function () {
    var e4js = require('events4js');

    Some_Event_Producer = function () {
        this.initialize();
    }
    var p = Some_Event_Producer.prototype = new e4js.EventProducer();
    p.initialize_event = p.initialize;

    p.initialize = function () {
        this.initialize_event();
    }
	return Some_Event_Producer;
})();
__________________________________________________________________________________________


Some tricks :
=> autoLaunch 
The autolaunch is a way to fire an event after another. For example fire "end" after "success" or "error"
Just give some config to the initialize_envent method :
__________________________________________________________________________________________
this.initialize_event({
    autoLaunch: {
        'end': ['success', 'error']
    }
});
__________________________________________________________________________________________

=> waitFor 
The wait for allow to fire an event after a list of events fire. For example fire "tree" if "one" and "two" have been fire.
Just give some config to the initialize_envent method :
__________________________________________________________________________________________
this.initialize_event({
    waitFor: {
        'tree': ['two', 'one'],
        'l': ['m', 'n']
    }
});
__________________________________________________________________________________________

Other examples in the tests directory