stackware

0.0.2 • Public • Published

stackware

Stackware is a basic connect-style middleware handler for node.js, used for pushing objects through a list of functions, modifying them and handling errors.

Installation

npm install stackware

Usage

  var Stackware = require('stackware');
  var sw        = new Stackware();
  
  sw.use(function middleware1(obj1, obj2, next) {
    obj1.foo = 'bar';
    next();
  });
  sw.use(function middleware2(obj1, obj2, next) {
    obj2.bar = 'foo';
    // stop here
  });
  sw.handle(obj1, obj2);

Documentation

Class: Stackware

Create a Stackware object.

var Stackware = require('stackware');
var sw        = new Stackware();

Methods

use(function)

Add a middleware to the stack. The function is called with the same arguments given to handle (see below), plus a callback function which can take an error.

  sw.use(function middleware1(obj1, obj2, next) {
    obj1.foo = 'bar';
    next();
  });
  sw.handle(obj1, obj2);

When the callback is called with an error, further middlewares will be skipped until we reach an error handler. It's basically a middleware with an error argument prepended to the others.

  sw.use(function middleware1(obj, next) {
    next(new Error('Something happened'));
  });
  sw.use(function errorHandler(err, obj, next) {
    console.log(err);
  });
  sw.handle(obj);

handle(obj1, obj2, ...)

Push any number of objects through the middlewares.
NB: only variables passed by reference can be changed inside the middlewares (i.e. objects, arrays).

Readme

Keywords

none

Package Sidebar

Install

npm i stackware

Weekly Downloads

8

Version

0.0.2

License

MIT

Last publish

Collaborators

  • nojhamster