add .forEach .atEnd .forFirst

README.md

@@ -21,6 +21,7 @@ accepts call to execute in gulp pipeline.
 ```javascript
 import * as gulp from 'gulp';
 import gulpFunction from 'gulp-function' // default ES6 export
+// import {forFirst, forEach, atEnd} from 'gulp-function'
 let Q = require("q");
 
 let myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object
@@ -38,6 +39,7 @@ let myFunction = function (file, enc) { // file and enc are optional in case you
 gulp.task('gulpTest',function() {
     let stream = gulp.src('./mydir/*.something')
         .pipe(gulpFunction(myFunction,'forEach')) //read the notes below
+        // .pipe(gulpFunction.forEach(myFunction))
         .pipe(gulp.dest("./build/"));
     return stream; // by returning the stream gulp knows when our task has finished.
 });

dist/index.d.ts

@@ -5,5 +5,8 @@ export declare type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd';
 export interface IPromiseFunction {
     (file?: any, enc?: any): PromiseLike<any>;
 }
-declare let mainExportFunction: (functionsToExecuteArg: IPromiseFunction | IPromiseFunction[], executionModeArg?: TExecutionMode) => Transform;
-export default mainExportFunction;
+declare let defaultExport: (functionsToExecuteArg: IPromiseFunction | IPromiseFunction[], executionModeArg?: TExecutionMode) => Transform;
+export declare let forEach: (funcArg: IPromiseFunction) => void;
+export declare let forFirst: (funcArg: IPromiseFunction) => void;
+export declare let atEnd: (funcArg: IPromiseFunction) => void;
+export default defaultExport;

dist/index.js

@@ -2,7 +2,7 @@
 require("typings-global");
 const q = require("q");
 const through2 = require("through2");
-let mainExportFunction = (functionsToExecuteArg, executionModeArg = 'forEach') => {
+let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
     let promiseArray = [];
     let runFunction = function (functionArg, file, enc) {
         let returnValue = functionArg(file, enc);
@@ -63,6 +63,15 @@ let mainExportFunction = (functionsToExecuteArg, executionModeArg = 'forEach') =
     };
     return through2.obj(forEach, atEnd);
 };
+exports.forEach = (funcArg) => {
+    defaultExport(funcArg, 'forEach');
+};
+exports.forFirst = (funcArg) => {
+    defaultExport(funcArg, 'forFirst');
+};
+exports.atEnd = (funcArg) => {
+    defaultExport(funcArg, 'atEnd');
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = mainExportFunction;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHVCQUFzQjtBQUN0QixxQ0FBb0M7QUFTcEMsSUFBSSxrQkFBa0IsR0FBRyxDQUNyQixxQkFBNEQsRUFDNUQsZ0JBQWdCLEdBQW1CLFNBQVM7SUFHNUMsSUFBSSxZQUFZLEdBQUcsRUFBRSxDQUFBO0lBQ3JCLElBQUksV0FBVyxHQUFHLFVBQVUsV0FBVyxFQUFFLElBQUksRUFBRSxHQUFHO1FBQzlDLElBQUksV0FBVyxHQUFHLFdBQVcsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDeEMsRUFBRSxDQUFDLENBQUMsT0FBTyxXQUFXLEtBQUssV0FBVyxJQUFJLE9BQU8sV0FBVyxDQUFDLElBQUksS0FBSyxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQ2hGLFlBQVksQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUE7UUFDbEMsQ0FBQztJQUNMLENBQUMsQ0FBQTtJQUVELElBQUksbUJBQW1CLEdBQUcsVUFBVSxJQUFJLEVBQUUsR0FBRztRQUN6QyxFQUFFLENBQUMsQ0FBQyxPQUFPLHFCQUFxQixLQUFLLFVBQVUsQ0FBQyxDQUFDLENBQUM7WUFDOUMsV0FBVyxDQUFDLHFCQUFxQixFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtRQUNqRCxDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMscUJBQXFCLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDOUMsR0FBRyxDQUFDLENBQUMsSUFBSSxXQUFXLElBQUkscUJBQXFCLENBQUMsQ0FBQyxDQUFDO2dCQUM1QyxXQUFXLENBQUMscUJBQXFCLENBQUMsV0FBVyxDQUFDLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1lBQzlELENBQUM7UUFDTCxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixNQUFNLElBQUksS0FBSyxDQUFDLGtFQUFrRSxDQUFDLENBQUE7UUFDdkYsQ0FBQztRQUNELE1BQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLFlBQVksQ0FBQyxDQUFBO0lBQzlCLENBQUMsQ0FBQTtJQUVELElBQUksZUFBZSxHQUFHLEtBQUssQ0FBQTtJQUMzQixJQUFJLE9BQU8sR0FBRyxVQUFVLElBQUksRUFBRSxHQUFHLEVBQUUsRUFBRTtRQUNqQyxNQUFNLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUM7WUFDdkIsS0FBSyxTQUFTO2dCQUNWLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUM7b0JBQ2hDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2xCLENBQUMsQ0FBQyxDQUFBO2dCQUNGLEtBQUssQ0FBQTtZQUNULEtBQUssVUFBVTtnQkFDWCxFQUFFLENBQUMsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDO29CQUNsQixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDO3lCQUN6QixJQUFJLENBQUM7d0JBQ0YsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtvQkFDbEIsQ0FBQyxDQUFDLENBQUE7Z0JBQ1YsQ0FBQztnQkFBQyxJQUFJLENBQUMsQ0FBQztvQkFDSixFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNsQixDQUFDO2dCQUNELGVBQWUsR0FBRyxJQUFJLENBQUE7Z0JBQ3RCLEtBQUssQ0FBQTtZQUNULEtBQUssT0FBTztnQkFDUixFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNkLEtBQUssQ0FBQTtZQUNUO2dCQUNJLEtBQUssQ0FBQTtRQUNiLENBQUM7SUFDTCxDQUFDLENBQUE7SUFFRCxJQUFJLEtBQUssR0FBRyxVQUFVLEVBQUU7UUFDcEIsRUFBRSxDQUFDLENBQUMsZ0JBQWdCLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQztZQUMvQixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDO2dCQUNqQyxFQUFFLEVBQUUsQ0FBQTtZQUNSLENBQUMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osRUFBRSxFQUFFLENBQUE7UUFDUixDQUFDO0lBQ0wsQ0FBQyxDQUFBO0lBQ0QsTUFBTSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFBO0FBQ3ZDLENBQUMsQ0FBQTs7QUFFRCxrQkFBZSxrQkFBa0IsQ0FBQSJ9
+exports.default = defaultExport;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHVCQUFzQjtBQUN0QixxQ0FBb0M7QUFTcEMsSUFBSSxhQUFhLEdBQUcsQ0FDaEIscUJBQTRELEVBQzVELGdCQUFnQixHQUFtQixTQUFTO0lBRzVDLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQTtJQUNyQixJQUFJLFdBQVcsR0FBRyxVQUFVLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUM5QyxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ3hDLEVBQUUsQ0FBQyxDQUFDLE9BQU8sV0FBVyxLQUFLLFdBQVcsSUFBSSxPQUFPLFdBQVcsQ0FBQyxJQUFJLEtBQUssV0FBVyxDQUFDLENBQUMsQ0FBQztZQUNoRixZQUFZLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1FBQ2xDLENBQUM7SUFDTCxDQUFDLENBQUE7SUFFRCxJQUFJLG1CQUFtQixHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUc7UUFDekMsRUFBRSxDQUFDLENBQUMsT0FBTyxxQkFBcUIsS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBQzlDLFdBQVcsQ0FBQyxxQkFBcUIsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDakQsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQzlDLEdBQUcsQ0FBQyxDQUFDLElBQUksV0FBVyxJQUFJLHFCQUFxQixDQUFDLENBQUMsQ0FBQztnQkFDNUMsV0FBVyxDQUFDLHFCQUFxQixDQUFDLFdBQVcsQ0FBQyxFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtZQUM5RCxDQUFDO1FBQ0wsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osTUFBTSxJQUFJLEtBQUssQ0FBQyxrRUFBa0UsQ0FBQyxDQUFBO1FBQ3ZGLENBQUM7UUFDRCxNQUFNLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQTtJQUM5QixDQUFDLENBQUE7SUFFRCxJQUFJLGVBQWUsR0FBRyxLQUFLLENBQUE7SUFDM0IsSUFBSSxPQUFPLEdBQUcsVUFBVSxJQUFJLEVBQUUsR0FBRyxFQUFFLEVBQUU7UUFDakMsTUFBTSxDQUFDLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxDQUFDO1lBQ3ZCLEtBQUssU0FBUztnQkFDVixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO29CQUNoQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNsQixDQUFDLENBQUMsQ0FBQTtnQkFDRixLQUFLLENBQUE7WUFDVCxLQUFLLFVBQVU7Z0JBQ1gsRUFBRSxDQUFDLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQztvQkFDbEIsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQzt5QkFDekIsSUFBSSxDQUFDO3dCQUNGLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7b0JBQ2xCLENBQUMsQ0FBQyxDQUFBO2dCQUNWLENBQUM7Z0JBQUMsSUFBSSxDQUFDLENBQUM7b0JBQ0osRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDbEIsQ0FBQztnQkFDRCxlQUFlLEdBQUcsSUFBSSxDQUFBO2dCQUN0QixLQUFLLENBQUE7WUFDVCxLQUFLLE9BQU87Z0JBQ1IsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDZCxLQUFLLENBQUE7WUFDVDtnQkFDSSxLQUFLLENBQUE7UUFDYixDQUFDO0lBQ0wsQ0FBQyxDQUFBO0lBRUQsSUFBSSxLQUFLLEdBQUcsVUFBVSxFQUFFO1FBQ3BCLEVBQUUsQ0FBQyxDQUFDLGdCQUFnQixLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUM7WUFDL0IsbUJBQW1CLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQztnQkFDakMsRUFBRSxFQUFFLENBQUE7WUFDUixDQUFDLENBQUMsQ0FBQTtRQUNOLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLEVBQUUsRUFBRSxDQUFBO1FBQ1IsQ0FBQztJQUNMLENBQUMsQ0FBQTtJQUNELE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQTtBQUN2QyxDQUFDLENBQUE7QUFFVSxRQUFBLE9BQU8sR0FBRyxDQUFDLE9BQXlCO0lBQzNDLGFBQWEsQ0FBQyxPQUFPLEVBQUUsU0FBUyxDQUFDLENBQUE7QUFDckMsQ0FBQyxDQUFBO0FBRVUsUUFBQSxRQUFRLEdBQUcsQ0FBQyxPQUF5QjtJQUM1QyxhQUFhLENBQUMsT0FBTyxFQUFFLFVBQVUsQ0FBQyxDQUFBO0FBQ3RDLENBQUMsQ0FBQTtBQUVVLFFBQUEsS0FBSyxHQUFHLENBQUMsT0FBeUI7SUFDekMsYUFBYSxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQTtBQUNuQyxDQUFDLENBQUE7O0FBRUQsa0JBQWUsYUFBYSxDQUFBIn0=

test/test.ts

@@ -1,63 +1,64 @@
 import 'typings-test'
-let gulp = require('gulp');
+let gulp = require('gulp')
 import gulpFunction from '../dist/index'
-let beautylog = require('beautylog')
+
+import * as beautylog from 'beautylog'
 let Q = require('q')
 
 let myFunction = function () {
     let done = Q.defer()
-    beautylog.log('Function executed');
-    done.resolve();
-    return done.promise;
-};
+    beautylog.log('Function executed')
+    done.resolve()
+    return done.promise
+}
 let myFunction2 = function () {
-    let done = Q.defer();
-    beautylog.ok('Function2 executed');
-    done.resolve();
-    return done.promise;
-};
+    let done = Q.defer()
+    beautylog.ok('Function2 executed')
+    done.resolve()
+    return done.promise
+}
 let myFunction3 = function () {
-    let done = Q.defer();
-    beautylog.success('Function3 executed');
-    done.resolve();
-    return done.promise;
-};
+    let done = Q.defer()
+    beautylog.success('Function3 executed')
+    done.resolve()
+    return done.promise
+}
 
 let beforeFunction = function () {
-    let done = Q.defer();
-    beautylog.success('beforeFunction executed');
-    done.resolve();
-    return done.promise;
-};
+    let done = Q.defer()
+    beautylog.success('beforeFunction executed')
+    done.resolve()
+    return done.promise
+}
 
-let middleFunctionRun = false;
+let middleFunctionRun = false
 
 let middleFunction = function () {
-    let done = Q.defer();
-    beautylog.success('middleFunction executed');
+    let done = Q.defer()
+    beautylog.success('middleFunction executed')
     setTimeout(function(){
-        beautylog.log('timeout fired');
-        middleFunctionRun = true;
-        done.resolve();
-    }, 500);
-    return done.promise;
-};
+        beautylog.log('timeout fired')
+        middleFunctionRun = true
+        done.resolve()
+    }, 500)
+    return done.promise
+}
 
 let afterFunction = function () {
-    let done = Q.defer();
-    beautylog.success('afterFunction executed');
-    done.resolve();
-    return done.promise;
-};
+    let done = Q.defer()
+    beautylog.success('afterFunction executed')
+    done.resolve()
+    return done.promise
+}
 
 let timeoutFunction = function(){
-    let done = Q.defer();
+    let done = Q.defer()
     setTimeout(function(){
-        beautylog.log('largeTimeout fired');
-        done.resolve();
-    },2000);
-    return done.promise;
-};
+        beautylog.log('largeTimeout fired')
+        done.resolve()
+    },2000)
+    return done.promise
+}
 
 
 
@@ -65,54 +66,54 @@ describe('gulpFunction',function(){
     it('should run through smoothly with ' + "'forEach'",function(done){
         gulp.src('./test/*.md')
             .pipe(gulpFunction(myFunction,'forEach'))
-            .pipe(gulp.dest('./test/result/'));
+            .pipe(gulp.dest('./test/result/'))
 
         gulp.src('./test/*.md')
             .pipe(gulpFunction([myFunction2,myFunction3],'forEach'))
             .pipe(gulp.dest('./test/result/'))
-            .pipe(gulpFunction(done,'atEnd'));
+            .pipe(gulpFunction(done,'atEnd'))
 
-    });
+    })
 
     it('should run through smoothly with ' + "'atEnd'",function(done){
         gulp.src('./test/*.md')
             .pipe(gulpFunction(myFunction,'atEnd'))
-            .pipe(gulp.dest('./test/result/'));
+            .pipe(gulp.dest('./test/result/'))
 
         gulp.src('./test/*.md')
             .pipe(gulpFunction([myFunction2,myFunction3],'atEnd'))
             .pipe(gulp.dest('./test/result/'))
-            .pipe(gulpFunction(done,'atEnd'));
-    });
+            .pipe(gulpFunction(done,'atEnd'))
+    })
 
     it('should run through smoothly once with ' + "'atFirst'",function(done){
 
         gulp.src('./test/*.md')
             .pipe(gulpFunction([myFunction2,myFunction3],'forFirst'))
             .pipe(gulp.dest('./test/result/'))
-            .pipe(gulpFunction(done,'atEnd'));
-    });
+            .pipe(gulpFunction(done,'atEnd'))
+    })
 
     it('should run in order',function(done){
-        this.timeout(5000);
+        this.timeout(5000)
         let stream = gulp.src('./test/*.md')
             .pipe(gulpFunction([beforeFunction,middleFunction,middleFunction],'atEnd'))
             .pipe(gulpFunction(function(){
-                beautylog.log('stream progressed');
-                let done2 = Q.defer();
-                done2.resolve();
-                return done2.promise;
+                beautylog.log('stream progressed')
+                let done2 = Q.defer()
+                done2.resolve()
+                return done2.promise
             },'forEach'))
             .pipe(gulpFunction(function(){
-                beautylog.log('nextStep');
+                beautylog.log('nextStep')
             }))
             .pipe(gulpFunction(afterFunction,'atEnd'))
-            .pipe(gulpFunction(timeoutFunction,'atEnd'));
+            .pipe(gulpFunction(timeoutFunction,'atEnd'))
 
         stream.on('finish',function(){
-            beautylog.info('stream finished');
-            done();
-        });
-    });
-});
+            beautylog.info('stream finished')
+            done()
+        })
+    })
+})
 

ts/index.ts

@@ -9,7 +9,7 @@ export interface IPromiseFunction {
     (file?, enc?): PromiseLike<any>
 }
 
-let mainExportFunction = (
+let defaultExport = (
     functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
     executionModeArg: TExecutionMode = 'forEach'
 ): Transform => {
@@ -74,4 +74,16 @@ let mainExportFunction = (
     return through2.obj(forEach, atEnd)
 }
 
-export default mainExportFunction
+export let forEach = (funcArg: IPromiseFunction) => {
+    defaultExport(funcArg, 'forEach')
+}
+
+export let forFirst = (funcArg: IPromiseFunction) => {
+    defaultExport(funcArg, 'forFirst')
+}
+
+export let atEnd = (funcArg: IPromiseFunction) => {
+    defaultExport(funcArg, 'atEnd')
+}
+
+export default defaultExport