Shrext NPM | npm.io

Shrext

A dead simple TypeScript middleware engine.

Shrext is a simple tool that helps you compose reusable middleware. Inspired by Middy, made for anything, not just AWS Lambda.

Installation

Install using npm:

npm install shrext

Usage

Basic Example

import { MiddlewareFnObject, shrext } from './src'

type ApiHandler = (req: { auth_token: string }) => unknown

type User = { token: string }
type ContextWithUser = { user: User }

const handler = shrext<ApiHandler, ContextWithUser>((context) => {
  console.log(context.user.token)
})

const withUser: MiddlewareFnObject<ApiHandler, ContextWithUser> = {
  before: async (context) => {
    const {
      args: [req],
    } = context
    const user: User = await getUser(req.auth_token)
    Object.assign(context, { user })
  },
}
// attach the middleware
handler.use(withUser)

handler({ auth_token: 'qwerty' })
// Result: qwerty

Alternative composition:

shrext<ApiHandler, ContextWithUser>()
  .use(withUser)
  .handler()

There are three types of middleware: before, after, and onError. All of them receive a context object, that by default has an args property - array of arguments the handler is called with. You can attach properties to context, as it's passed through the middleware layers.

The middleware call order:

before - order in which it's attached
after - reverse attach order
onError - reverse attach order, like after

Some rules and behavior to keep in mind:

Handler and every middleware are always awaited, the call on instance always returns a Promise
The instance returned from shrext() is mutable and every method returns self. This allows to chain method calls, as well as compose separately, as shown above.
Because of the mutability, you should use clone() when reusing and extending shrex handler instances.