Giter Club home page Giter Club logo

gulp-middleware's Introduction

gulp-middleware NPM version NPM downloads Build Status

Run middleware in a gulp pipeline/vinyl source stream.

Install

Install with npm:

$ npm install gulp-middleware --save

Jump to 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))
});

Jump to 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|Function}: Function or 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|Function}: Function or 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

License

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


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

gulp-middleware's People

Contributors

jonschlinkert avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.