Package Exports

middleware-utils

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (middleware-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

middleware-utils

Utils for Template middleware.

Install with npm

npm i middleware-utils --save

Usage

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

API

.series

Run middleware in series

Params

fns {Array}: Array of middleware functions

Example

var middleware = require('./middleware/');

template.onLoad(/\.js$/, utils.series([
  middleware.foo,
  middleware.bar,
  middleware.baz,
]));

.parallel

Run middleware in parallel.

Params

fns {Array}: Array of middleware functions

Example

var middleware = require('./middleware/');

template.onLoad(/\.js$/, utils.parallel([
  middleware.foo,
  middleware.bar,
  middleware.baz,
]));

.error

Output a formatted middleware error.

Params

methodName {String}: The middleware method name (verb)

Example

template.postRender(/./, function (file, next) {
  // do stuff to file
  next();
}, utils.error('postRender'));

.handleError

Handle middleware errors for the .handle() method.

Params

file {Object}: Vinyl file object or template object.
methodName {String}: The middleware method name (verb)

Example

template.handle('onFoo', file, utils.handleError(file, 'onFoo'));

assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more
template: Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… more
verb: Documentation generator for GitHub projects. Extremely powerful, easy to use, can generate anything from API… more

Running tests

Install dev dependencies:

npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

This file was generated by verb-cli on April 29, 2015.