Definitions for gulp-plumber

This commit is contained in:
Joe Skeen
2015-08-21 09:17:54 -06:00
parent 4b8efa4350
commit 58fe0b0e72
2 changed files with 87 additions and 0 deletions
+36
View File
@@ -0,0 +1,36 @@
/// <reference path="../node/node" />
/// <reference path="../gulp/gulp" />
/// <reference path="gulp-plumber" />
import gulp = require('gulp');
import plumber = require('gulp-plumber');
//default behavior
gulp.src('./src/*.ext')
.pipe(plumber())
.pipe(gulp.dest('./dist'));
//error handler function
gulp.src('./src/*.ext')
.pipe(plumber((error) => {
console.log(error);
}))
.pipe(gulp.dest('./dist'));
gulp.src('./src/*.ext')
.pipe(plumber({}))
.pipe(gulp.dest('./dist'));
gulp.src('./src/*.ext')
.pipe(plumber({ inherit: false }))
.pipe(gulp.dest('./dist'));
gulp.src('./src/*.ext')
.pipe(plumber({ errorHandler: (error) => console.log(error) }))
.pipe(gulp.dest('./dist'));
//plumber.stop()
gulp.src('./src/*.scss')
.pipe(plumber())
.pipe(plumber.stop())
.pipe(gulp.dest('./dist'));
+51
View File
@@ -0,0 +1,51 @@
// Type definitions for gulp-plumber
// Project: https://github.com/floatdrop/gulp-plumber
// Definitions by: Joe Skeen <http://github.com/joeskeen>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../node/node.d.ts" />
/** Prevent pipe breaking caused by errors from gulp plugins */
declare module 'gulp-plumber' {
/** Prevent pipe breaking caused by errors from gulp plugins */
interface GulpPlumber {
/**
* Returns Stream, that fixes pipe methods on Streams that are next in pipeline.
*
* @param options Sets options as described in the Options interface
*/
(options?: Options): NodeJS.ReadWriteStream;
/**
* Returns Stream, that fixes pipe methods on Streams that are next in pipeline.
*
* @param errorHandler the function to be attached to the stream on('error')
*/
(errorHandler: ErrorHandlerFunction): NodeJS.ReadWriteStream;
/** returns default behaviour for pipeline after it was piped */
stop(): NodeJS.ReadWriteStream;
}
interface Options {
/**
* Handle errors in underlying streams and output them to console. Default true.
* If function passed, it will be attached to stream on('error')
* If false passed, error handler will not be attached
* If undefined passed, default error handler will be attached
*/
errorHandler?: ErrorHandlerFunction | boolean;
/** Monkeypatch pipe functions in underlying streams in pipeline. Default true. */
inherit?: boolean;
}
/** an error handler function to be attached to the stream on('error') */
interface ErrorHandlerFunction {
/** an error handler function to be attached to the stream on('error') */
(error): void;
}
/** Prevent pipe breaking caused by errors from gulp plugins */
var gulpPlumber: GulpPlumber;
export = gulpPlumber;
}