1.0.0 • Published 4 years ago

middleware-utils v1.0.0

Weekly downloads
2,351
License
MIT
Repository
github
Last release
4 years ago

middleware-utils NPM version NPM monthly downloads NPM total downloads Linux Build Status

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 project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on July 16, 2017.

1.0.0

4 years ago

0.3.1

5 years ago

0.3.0

5 years ago

0.2.0

5 years ago

0.1.4

6 years ago

0.1.3

6 years ago

0.1.2

6 years ago

0.1.1

6 years ago

0.1.0

6 years ago