push.rocks/gulp-function
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Philipp Kunz 2016-02-14 18:40:37 +01:00
parent 6e55ed3162
commit 17aa25fb61
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -12,9 +12,18 @@ accepts call to execute in gulp pipeline.
```javascript ```javascript
var gulp = require("gulp"); var gulp = require("gulp");
var gulpFunction = require("gulp-function"); var gulpFunction = require("gulp-function");
var Q = require("q");
var myFunction = function () { var myFunction = function () {
var done = Q.defer();
console.log("Hello World!") 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() { gulp.task('gulpTest',function() {
@ -25,4 +34,5 @@ gulp.task('gulpTest',function() {
``` ```
> Note: The first argument of gulpFunction can also be an array of multiple functionnames. > 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' > Note: the second argument can be empty (defaults to 'forEach') or 'atEnd'