From 63fe7c7423016ad75fcb5157c5aa36090466d594 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Sun, 30 Apr 2017 17:11:40 +0200 Subject: [PATCH] update README --- README.md | 60 +++++++++++++------------------------------------------ 1 file changed, 14 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 26b9119..6cccf41 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ # gulp-function -accepts call to execute in gulp pipeline. +accepts a function call as parameter to execute in gulp pipeline ## Availabililty -[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-function) -[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/gulp-function) -[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-function) -[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/gulp-function/) +[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-function) +[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/gulp-function) +[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-function) +[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/gulp-function/) ## Status for master -[![build status](https://gitlab.com/pushrocks/gulp-function/badges/master/build.svg)](https://gitlab.com/pushrocks/gulp-function/commits/master) -[![coverage report](https://gitlab.com/pushrocks/gulp-function/badges/master/coverage.svg)](https://gitlab.com/pushrocks/gulp-function/commits/master) +[![build status](https://GitLab.com/pushrocks/gulp-function/badges/master/build.svg)](https://GitLab.com/pushrocks/gulp-function/commits/master) +[![coverage report](https://GitLab.com/pushrocks/gulp-function/badges/master/coverage.svg)](https://GitLab.com/pushrocks/gulp-function/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/gulp-function.svg)](https://www.npmjs.com/package/gulp-function) [![Dependency Status](https://david-dm.org/pushrocks/gulp-function.svg)](https://david-dm.org/pushrocks/gulp-function) [![bitHound Dependencies](https://www.bithound.io/github/pushrocks/gulp-function/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/gulp-function/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/pushrocks/gulp-function/badges/code.svg)](https://www.bithound.io/github/pushrocks/gulp-function) @@ -17,45 +18,12 @@ accepts call to execute in gulp pipeline. [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) -### 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"); +## Usage +Use TypeScript for best in class instellisense. -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; -} +For further information read the linked docs at the top of this README. -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. -}); -``` +> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) -### 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**!!! - -[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks) +[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)