gulp-function/README.md
2016-02-14 18:42:45 +01:00

1.7 KiB

gulp-function

accepts call to execute in gulp pipeline.

Status

Build Status Dependency Status devDependency Status bitHound Code Coverage Status

Usage

var gulp = require("gulp");
var gulpFunction = require("gulp-function");
var Q = require("q");

var myFunction = function () {
    var done = Q.defer();
    console.log("Hello World!")
    
    // NOTE:
    // you can use done.resolve as callback function
    // of any async tasks within this function
    done.resolve();
    
    return done.promise;
}

gulp.task('gulpTest',function() {
    var stream = gulp.src('./mydir/*.something')
        .pipe(gulpFunction(myFunction,'forEach')) //read the notes below
        .pipe(gulp.dest("./build/"));
    return stream; // by returning the stream gulp knows when our task has finished.
});

Note: The first argument of gulpFunction can also be an array of multiple functionnames. Each function can return a promise. the pipe stop will finish when every promise is fullfilled.
Note: the second argument can be empty (defaults to 'forEach') or 'atEnd'