@ebec/http

Extendable base error classes for http.

Source

npm

Version: 0.0.4

Version published: 4 years ago

Maintainers: 1

Created: 4 years ago

Source

@ebec/http 🥁

This library provides HTTP base error classes (NotFoundError, InternalServerError, ...), which can simply be extended.

Table of Contents

Installation

npm install @ebec/http --save

Usage

The usage is pretty easy, just import one of the client or server error classes and use them in throw- & catch- statements.

Basic

import {
    InternalServerError,
    NotFoundError
} from "@ebec/http";

const clientError = new NotFoundError();

console.log(clientError.getOption('statusCode'));
// 404

console.log(clientError.getOption('logMessage'));
// false

console.log(clientError.getOption('code'));
// NOT_FOUND

// ------------------------------------

const serverError = new InternalServerError({
    logLevel: 'warning'
});

console.log(serverError.getOption('statusCode'));
// 500

console.log(serverError.getOption('logMessage'));
// true

console.log(serverError.getOption('code'));
// INTERNAL_SERVER_ERROR

console.log(serverError.getOption('logLevel'));
// warning

Another way to use the predefined error classes is to extend them, with own options.

Extend

import {
    Options,
    mergeOptions,
    NotFoundError
} from "@ebec/http";

class UserNotFound extends NotFoundError {
    constructor(options?: Options) {
        super(mergeOptions(
            {
                message: 'The user was not found.',
                code: 'USER_NOT_FOUND'
            },
            ...(options ? options : {})
        ));
    }
}