brettz9 / htteepee

Allows for adding middleware layers to Node.js servers

htteepee

A teepee you can use for adding layers over your Node HTTP servers!

Allows you to easily add middleware layers to your Node.js server.

Uses stack but allowing for a very minor simplification in API usage.

Installation

npm i htteepee

Usage

Just change:

const http = require('http');

...to this:

const http = require('htteepee');

...and add your middleware functions to the beginning of createServer calls (without need for an extra require and wrapping):

http.createServer(
  require('./middleware')('Hello '),
  require('./other-middleware')('there '),

  function (req, res) {
    res.end('World!');
  }
).listen(1337, '127.0.0.1');

(Our middleware examples are just passing in strings for config, but yours could be an object, empty, etc., and while our middleware is just prepending a string, yours could do something more sophisticated.)

If you want to minimize modification with the source files you are converting to htteepee even more, you can require your own file containing the baked in middleware:

const http = require('./baked-in-middleware');

http.createServer(function (req, res) {
  res.end('World!');
}).listen(1337, '127.0.0.1');

...and use either the createMiddlewareServer method inside the required middleware file:

const http = require('htteepee');

http.createServer = http.createMiddlewareServer(
  require('./middleware')(
    'Hello '
  ),
  require('./other-middleware')(
    'there '
  )
);

module.exports = http;

...or for an even easier API, just use createMiddleware:

module.exports = require('htteepee').createMiddleware(
  require('./middleware')(
    'Hello '
  ),
  require('./other-middleware')(
    'there '
  )
);

API

createServer(...callbacks)

Passes on all callbacks to stack and uses the result to set up an http server.

Each callback accepted by stack is a function which accepts three arguments: req, res, and next. The latter should be called with no arguments to continue the chain or be called with an Error object whose stack property will be printed and logged and the chain discontinued.

(Note: The last argument can be your regular createServer(req, res) handler where no next argument is expected unless you wish to default to the 404/500 behavior mentioned below.)

Will give a 404 Not Found if no processing has occurred (e.g., if no callbacks are passed in or the chain was continued by all callbacks including the last one).

Will give a 500 Error if an exception is thrown by one of the callbacks or if next were called by one of them with an Error (or any truthy item).

createMiddlewareServer(...middlewareCallbacks)

Accepts middleware callbacks of the same signature described under createServer (but the final argument is not expected to be the main application createServer callback).

Returns a function which can be set on htteepee (or used standalone) to function as the main application createServer.

createMiddleware(...middlewareCallbacks)

Replaces the htteepee createServer with the result of calling createMiddlewareServer with the middlewareCallbacks arguments.

To-dos

1. Tests
2. https

htteepee's Issues

LICENSE?

you need to include the license text for MIT license

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.