@michielkn/express-http-exceptions

Express HTTP Exceptions

Description

This is a simple module that adds the functionality to throw an Exception in your express application that gets converted to an HTTP Response

Installation

    yarn add @michielkn/express-http-exceptions

Setup

    import { HttpExceptionMiddleware } from '@michielkn/express-http-exceptions'    // import the express middleware
    import express from 'express';                                                  // import express
    const app = express();
    
    // add your own code here
    
    app.use(HttpExceptionMiddleware); // add the middleware after your custom code


    app.listen(3000, () => { // Start the app
        console.log(`App listening on port 3000`);
    });

Usage

Throw an Exception in your express application

    import { HttpException } from '@michielkn/express-http-exceptions' // import the HttpException class

    throw New HttpException(404); // Will return a http response with code 404
    
    // or

    throw New HttpException(404, httpExceptionData); // Will return a 404 with some added data (see underneath)

HttpExceptionData

The data object is used to add some custom data to the response. The data object itself is optional as are all the fields in data

type HttpExceptionData = {
    message?: string                                    // This string that becomes the response message
    body?: unknown                                      // This will become the body
    headers?: HttpExceptionDataHeader[]                 // A list of headers that should be set (See HttpExceptionDataHeader)
}

// The header object used in the HttpExceptionData
type HttpExceptionDataHeader = {
    name: string,                                       // The name of the header
    value: number | string | ReadonlyArray<string>      // The value of the header
}

HttpStatusCodes enums

Instead of entering the http status-code as a number, there are also a couple of enums available that can be used. They are split up into the 5 types of status-codes and one "enum" that combines all enums together

import {
    InformationHttpStatusCodes,
    RedirectionHttpStatusCodes,
    SuccessHttpStatusCodes,
    ClientErrorHttpStatusCodes,
    ServerErrorHttpStatusCodes,
    HttpStatusCodes,
} from '@michielkn/express-http-exceptions';

throw New HttpException(HttpStatusCodes.NOT_FOUND); // ==> 404
// or
throw New HttpException(ClientErrorHttpStatusCodes.NOT_FOUND); // ==> 404