# gulp-custom-callback

> Custom callback for streams

Latest version **1.0.2** (published 2021-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-custom-callback
pnpm add gulp-custom-callback
yarn add gulp-custom-callback
bun add gulp-custom-callback
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-12-20 |
| First published | 2019-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 3 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alexander Krasnoyarov |
| Maintainers | tiross |
| Keywords | gulp, gulpplugin, gulpfriendly, callback, functions |

## Links

- npm: https://www.npmjs.com/package/gulp-custom-callback
- Repository: https://github.com/Tiross/gulp-custom-callback
- Homepage: https://github.com/Tiross/gulp-custom-callback#readme
- Issues: https://github.com/Tiross/gulp-custom-callback/issues
- npm.io page: https://npm.io/package/gulp-custom-callback

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [through2](https://npm.io/package/through2.md) ^4.0.0
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.1

## Recent versions

- 1.0.2 (latest) — 2021-12-20
- 1.0.1 — 2019-04-24
- 1.0.0 — 2019-03-15

## README

gulp-custom-callback
=============

[![npm version](https://badge.fury.io/js/gulp-custom-callback.svg)](https://www.npmjs.com/package/gulp-custom-callback)
[![build status](https://github.com/Tiross/gulp-custom-callback/actions/workflows/build.yml/badge.svg)](https://github.com/Tiross/gulp-custom-callback/actions/workflows/build.yml)
[![coverage status](https://coveralls.io/repos/github/Tiross/gulp-custom-callback/badge.svg?branch=master)](https://coveralls.io/github/Tiross/gulp-custom-callback?branch=master)
![snyk](https://snyk-widget.herokuapp.com/badge/npm/gulp-custom-callback/badge.svg)

Add own callback to streaming

## Install

```
npm install --dev gulp-custom-callback
```

## Usage transformFunction
```javascript
var less = require('gulp-less');
var callback = require('gulp-custom-callback');

gulp.task('less', function () {
  gulp.src('./less/**/*.less')
    .pipe(less({
      paths: [ path.join(__dirname, 'less', 'includes') ]
    }))
    .pipe(callback(function (file, enc, cb) {
      console.log(file);
      cb();
    }))
    .pipe(gulp.dest('./public/css'));
});
```

## Usage transformFunction and flushFunction
```javascript
var less = require('gulp-less');
var callback = require('gulp-custom-callback');

gulp.task('less', function () {
  gulp.src('./less/**/*.less')
    .pipe(less({
      paths: [ path.join(__dirname, 'less', 'includes') ]
    }))
    .pipe(callback(function (file, enc, cb) {
      console.log(file);
      cb();
    }, function (callback) {
      callback();
    }))
    .pipe(gulp.dest('./public/css'));
});
```

## Usage transformFunction with error
```javascript
var less = require('gulp-less');
var callback = require('gulp-custom-callback');

gulp.task('less', function () {
  gulp.src('./less/**/*.less')
    .pipe(less({
      paths: [ path.join(__dirname, 'less', 'includes') ]
    }))
    .pipe(callback(function (file, enc, cb) {
      console.log(file);
      cb('error');
    }))
    .pipe(gulp.dest('./public/css'));
});
```

## Usage transformFunction with new file
```javascript
var less = require('gulp-less');
var callback = require('gulp-custom-callback');

gulp.task('less', function () {
  gulp.src('./less/**/*.less')
    .pipe(less({
      paths: [ path.join(__dirname, 'less', 'includes') ]
    }))
    .pipe(callback(function (file, enc, cb) {
      var newFile = ...
      cb(null, newFile);
    }))
    .pipe(gulp.dest('./public/css'));
});
```

## Usage transformFunction with new file and append old file
```javascript
var less = require('gulp-less');
var callback = require('gulp-custom-callback');

gulp.task('less', function () {
  gulp.src('./less/**/*.less')
    .pipe(less({
      paths: [ path.join(__dirname, 'less', 'includes') ]
    }))
    .pipe(callback(function (file, enc, cb) {
      var newFile = ...
      cb(null, newFile, true);
    }))
    .pipe(gulp.dest('./public/css'));
});
```

## Options

once - Run callback once
```javascript
var less = require('gulp-less');
var callback = require('gulp-custom-callback');

gulp.task('less', function () {
  gulp.src('./less/**/*.less')
    .pipe(less({
      paths: [ path.join(__dirname, 'less', 'includes') ]
    }))
    .pipe(callback(function (file, enc, cb) {
      console.log(file);
      cb();
    }, {
      once: true
    }))
    .pipe(gulp.dest('./public/css'));
});
```

---
_Source: https://npm.io/package/gulp-custom-callback · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._