Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Commit

Permalink
Updated readmed with example case for gulp 4
Browse files Browse the repository at this point in the history
  • Loading branch information
Zardoz89 committed Jul 7, 2020
1 parent c68ecf1 commit bcddf73
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ npm install gulp-multi-process --save-dev

## Usage

### Gulp 3
`gulpfile.js`
```js
var gulp = require('gulp');
Expand All @@ -29,8 +30,36 @@ gulp.task('multi', function(cb) {
return gulpMultiProcess(['task1', 'task2'], cb);
});
```
### Gulp 4
`gulpfile.js`
```js
const gulp = require('gulp');
const gulpMultiProcess = require('gulp-multi-process');

function task1() {
// example
});

exports.task1 = task1;

function task2() {
// example
});

exports.task2 = task2;

// gulp single will run task1 and task2 on a serial way
exports.single = gulp.series(task1, task2)

function multi(done) {
// task1 and task2 will run in different processes
return gulpMultiProcess(['task1', 'task2'], done);
}

exports.multi = multi;
```

### Warning

Run task in multiple processes is not always good for performance because spawn a different node processes is slow. It also depends on how long time it takes to require your `gulpfile`.
Keep in mind that you can pass `true` as a third parameter to `gulpMultiProcess` fn in order to get optimal preformance. This will launch one process per core, and if there will be more of them than the number of cores on your machine it will put others into queue. When one process will finish its operation, the next one will be on launched.
Keep in mind that you can pass `true` as a third parameter to `gulpMultiProcess` fn in order to get optimal performance. This will launch one process per core, and if there will be more of them than the number of cores on your machine it will put others into queue. When one process will finish its operation, the next one will be on launched.

0 comments on commit bcddf73

Please sign in to comment.