Fixing Node pipes
Clone or download
Fetching latest commitโ€ฆ
Cannot retrieve the latest commit at this time.

๐Ÿ’ gulp-plumber

NPM version Build Status Dependency Status

Prevent pipe breaking caused by errors from gulp plugins

This ๐Ÿ’-patch plugin is fixing issue with Node Streams piping. For explanations, read this small article.

Briefly it replaces pipe method and removes standard onerror handler on error event, which unpipes streams on error by default.

Usage ๐Ÿ’

First, install gulp-plumber as a development dependency:

npm install --save-dev gulp-plumber

Then, add it to your gulpfile.js:

var plumber = require('gulp-plumber');
var coffee = require('gulp-coffee');


API ๐Ÿ’

๐Ÿ’ plumber([options])

Returns Stream, that fixes pipe methods on Streams that are next in pipeline.


Type: Object / Function Default: {}

Sets options described below from its properties. If type is Function it will be set as errorHandler.


Type: Boolean Default: true

Monkeypatch pipe functions in underlying streams in pipeline.


Type: Boolean / Function
Default: true

Handle errors in underlying streams and output them to console.

  • function - it will be attached to stream on('error').
  • false - error handler will not be attached.
  • true - default error handler will be attached.


This method will return default behaviour for pipeline after it was piped.

var plumber = require('gulp-plumber');


License ๐Ÿ’

MIT License