controlflow.js

/**
 * Module to handle the control flow of a node application.
 * It is mainly a wrapper for the control flow functions of async module.
 *
 * @module  control-flow
 * @requires    async
 */

// dependencies
var Series = require("./libs/Series.js");
var Waterfall = require("./libs/Waterfall.js");
var Parallel = require("./libs/Parallel.js");

/**
 * Initialize module
 */

/**
 * The control flow object that lets create the several kinds of control flow tasks.
 *
 * @class   ControlFlow
 */
function ControlFlow () {

    /**
     * Returns a series task object.
     *
     * @method createSeries
     * @return {Series} The object that generates a waterfall series flow task
     */
    this.createSeries = function () {

        // create a new series task
        return new Series();
    };

    /** 
     * Returns a waterfall task object.
     *
     * @method createWaterfall
     * @return {Waterfall} The object that generates a waterfall control flow task
     */
    this.createWaterfall = function () {

        // create a new waterfall task
        return new Waterfall();
    };

    /**
     * Creates a parallel task object.
     *
     * @method createParallel
     * @return {Parallel} The object that generates a parallel control flow task
     */
    this.createParallel = function () {

        // create a new parallel task
        return new Parallel();
    };
}

// export the module
module.exports = ControlFlow;

/**
 * Environment
 */
module.exports.env = process.env.NODE_ENV || 'dev';

/**
 * Module name.
 */
module.exports.fullname = "RwControlFlow";

/**
 * Module version.
 */
module.exports.version = '0.0.1';