From 5d15c96511b021414acf037319d3d601275644b6 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Sun, 30 Apr 2017 17:23:22 +0200 Subject: [PATCH] update docs and .gitignore --- .gitignore | 8 -------- docs/index.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 8 deletions(-) create mode 100644 docs/index.md diff --git a/.gitignore b/.gitignore index 70da2df..91d2f9a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,13 +1,5 @@ node_modules/ -.settings/ -.idea/ coverage/ -docs/ public/ pages/ -ts/*.js -ts/*.js.map -ts/typings/ -test/result/ - diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..ff9ffa8 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,40 @@ +### Usage +```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 + let 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() { + let stream = gulp.src('./mydir/*.something') + .pipe(gulpFunction(myFunction,'forEach')) //read the notes below + // .pipe(forEach(myFunction)) // if imported as >> import { forEach } from 'gulp-function' << + .pipe(gulp.dest("./build/")); + return stream; // by returning the stream gulp knows when our task has finished. +}); +``` + +### Notes: + +* 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. +When providing an array of functions be careful with modifying the file object -> race condition +* The second argument can be empty, it defaults to "forEach" +* The following options are available: + * "forFirst" - executes when first chunk/vinylfile of the stream reaches the pipestop. + file is pushed further down the line when function's returned promise is fullfilled. + * "forEach" - executes like "forFirst" but with every chunk/vinylfile in the stream; + * "atEnd" - executes after all chunks have passed and are processed in full. + That means the stream's "finish" event fires **before "atLast" is executed**!!! \ No newline at end of file