gulp-middleware

gulp-middleware

Run middleware in a gulp pipeline/vinyl source stream.

Install

Install with npm:

$ npm install gulp-middleware --save

See API docs.

Gulp usage

Use as a gulp plugin:

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

gulp.task('middleware', function() {
  return gulp.src('*.js')
    // function or array of functions
    .pipe(middleware(fns))
});

See API docs.

Vinyl usage

Use with vinyl-fs:

var fs = require('fs');
var File = require('vinyl');
var through = require('through2');
var middleware = require('gulp-middleware');

function toStream(path) {
  return fs.createReadStream(path)
    .pipe(through.obj(function(contents, enc, next) {
      next(null, new File({path, contents}));
    }))
}

toStream('README.md')
  .pipe(middleware(fn))
  .pipe(middleware([fn, fn, fn]))

function fn(file, next) {
  console.log(file);
  next();
}

API

middleware

Run middleware in series.

Params

• fns {Array}: Array of middleware functions

Example

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

gulp.task('middleware', function() {
  return gulp.src('*.js')
    .pipe(middleware(fn('bar')))
    .pipe(middleware([
      fn('foo'),
      fn('bar'),
      fn('baz')
    ]))
});

function fn(name) {
  return function(file, next) {
    console.log(name);
    next();
  };
}

.parallel

Run middleware in parallel.

Params

• fns {Array}: Array of middleware functions

Example

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

gulp.task('middleware', function() {
  return gulp.src('*.js')
    .pipe(middleware(fn('bar')))
    .pipe(middleware.parallel([
      fn('foo'),
      fn('bar'),
      fn('baz')
    ]))
});

function fn(name) {
  return function(file, next) {
    console.log(name);
    next();
  };
}

Related projects

You might also be interested in these projects:

• assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
• generate: Fast, composable, highly extendable project generator with a user-friendly and expressive API. | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

This document was generated by verb, please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 27, 2016.