README.md

middytohof ·

Convert Middy middleware plugins to higher-order functions returning lambda handlers.

Why?

Middy facilitates a middleware pattern very similar to express but for lambda handlers. It encapsulates common functionality into individual plugins separate from the primary business logic of your lambda’s handler.

Middytohof is for those who want to benefit from the plugins written for the Middy community, but prefer a functional approach over the middleware pattern when it comes to decorating lambda handlers.

Here’s a quick comparison to give you an idea of the difference:

Middleware pattern with Middy

const { middleware1, middleware2 } = require('middy/middlewares');
const middy = require('middy');

// This contains your primary business logic.
const myHandler = (event, context, callback) => {
  callback(null, { iAm: 'a response' });
};

module.exports = {
  myHandler: middy(myHandler)
    .use(middleware1())
    .use(middleware2()),
};

Functional pattern with Middy plugins through middytohof

const { compose } = require('ramda');
const { middleware1, middleware2 } = require('middy/middlewares');
const middytohof = require('middytohof');

// This contains your primary business logic.
const myHandler = (event, context, callback) => {
  callback(null, { iAm: 'a response' });
};

module.exports = {
  // Without ramda.
  myHandler: middytohof(middleware1())(
    middytohof(middleware2())(
      myHandler
    )
  ),
  // With ramda.
  myHandlerWithRamda: compose(
    middytohof(middleware1()),
    middytoHof(middleware2())
  )(myHandler),
};

Either pattern is perfectly reasonable. Now you have the option to choose while keeping the excellent plugins created for the Middy community! 🎉

Installation

yarn add middytohof

OR

npm i --save middytohof

Contributors

Contributors

Peter Sieg

License

middytohof is MIT licensed.