abhay-raizada / create-middleware

A small package to implement middleware pattern

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

create-middleware Build Status npm version codecov

A small package to implement middleware pattern. This package implements the middleware pattern similar to how express does. You can register global middlewares or event specific middlewares. Refer to Usage Guide for information on how to use.

Installation

  • Npm: npm i create-middleware
  • Yarn: yarn add create-middleware

Usage Guide

import middlewares from 'create-middlewares'
middlewares.registerMiddleware(middlewareFn1, middlewareFn2, [, fn3, ..., fnn]) // registering global middlewares
middlewares.registerMiddleware("some-event",middlewareFn1, middlewareFn2, [, fn3, ..., fnn]) // registering event specific middlewares

middlewares.execute("some-event", []args) // this will execute global middlewares and event specific middlewares in order they were attached
All the middlewares will recieve the arguments and next as the last argument

To create a new set of middlewares in a different context

import { createMiddleware } from 'create-middlewares'
const middlewares = createMiddleware()

An example of the middleware function

async function loggingMiddleware(someObj, next){
    logger.log(someObj)
    await next()
}

async function errorHandlerMiddleware(someObj, next){
    try{
        await next()
    } catch(e) {
        // handle error here
    }
}

Typically error handler middleware would registered at the beginning globally for it to catch all errors propagating from the middlewares.

Note: All middlewares should be async functions and every next call should be awaited for this feature to work correctly

About

A small package to implement middleware pattern

License:MIT License


Languages

Language:TypeScript 100.0%