middleware-utils

middleware-utils

Utils for Template middleware.

Install

Install with npm:

$ npm install --save middleware-utils

Usage

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

API

.series

Run one or more middleware in series.

Params

• fns {Array|Function}: Function or array of middleware functions

Example

var utils = require('middleware-utils');
app.preRender(/\.hbs$/, utils.series([
  fn('foo'),
  fn('bar'),
  fn('baz')
]));

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

.parallel

Run one or more middleware in parallel.

Params

• fns {Array|Function}: Function or array of middleware functions

Example

var utils = require('middleware-utils');
app.preRender(/\.hbs$/, utils.parallel([
  fn('foo'),
  fn('bar'),
  fn('baz')
]));

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

.error

Format errors for the middleware done function. Takes the name of the middleware method being handled.

Params

• method {String}: The middleware method name

Example

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

.handleError

Format errors for the app.handle() method.

Params

• view {Object}: View object
• method {String}: The middleware method name
• next {String}: Callback function

Example

app.handle('onFoo', view, utils.handleError(view, 'onFoo'));

.delims

Returns a function for escaping and unescaping erb-style template delimiters.

Params

• options {Object}

Example

var delims = mu.delims();
app.preRender(/\.tmpl$/, delims.escape());
app.postRender(/\.tmpl$/, delims.unescape());

About

Contributing

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

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && 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-generate-readme, v0.1.28, on August 02, 2016.