Error Handling Made in Simple For Express or Other Nodejs Framework

OpsError

Error handling made in simple for express or other nodejs framework.

Features

• Easy to use.
• Easy configuration.
• Add custom error.
• Add custom throw error.
• support commonjs, esm and typescript.

Installation

$ npm install ops-error
//or
$ yarn add ops-error

Example Express

For other framework you can find code in example folder.

//router.js

const express = require('express');
const { NotFoundError } = require("ops-error");
const myError = require("./myError");

// typescript or esm
// import { NotFoundError } from "ops-error";

let router = express.Router();

router.get('/user', (req, res) => {
    try {
        const data = findUser();
        if (!data) {
            throw new NotFoundError('User Not Found');
            // or
            // throw new NotFoundError();
            // message will generete => "Not Found Error"
        }
        return res.status(200).json({
            statusCode: 200,
            data
        })
    } catch (error) {
        return myError(error, res);
    }
});

// response error :
// {
//     "statusCode": 404,
//     "error": "User Not Found"
// }

module.exports = router;

//myError.js

const { getError } = require("ops-error");

module.exports = (err, res) => {
    const { statusCode, message } = getError(err);
    return res.status(statusCode).json({statusCode, error: message})
}

Middleware Error Handling

...

const { NotFoundError } = require("ops-error");
const myError = require("./myError");

//example route
app.use('/user', async (req, res) => {
    try {
        const data = await findUser();
        if (!data) {
            throw new NotFoundError('User Not Found');
        }
        return res.status(200).json({
            statusCode: 200,
            data
        })
    } catch (error) {
        throw error;
    }
});

//error handling middleware after route in express
app.use((err, req, res, next) => myError(err, res));

// response error :
// {
//     "statusCode": 404,
//     "error": "User Not Found"
// }

...

Add Custom Throw Error

...

const { OpsError, addThrowErrors } = require("ops-error");
const myError = require("./myError");

class PaymentRequiredError extends OpsError {
    static statusCode() { return 402 }
    static errorName() { return 'Payment Required Error' }
}

addThrowErrors([PaymentRequiredError]);

//example route
app.use('/user-payment', async (req, res) => {
    try {
        const data = await findUserPayment();
        if (!data) {
            throw new PaymentRequiredError('User Payment Required');
        }
        return res.status(200).json({
            statusCode: 200,
            data
        })
    } catch (error) {
        throw error;
    }
});

//error handling middleware after route in express
app.use((err, req, res, next) => myError(err, res));

// response error :
// {
//     "statusCode": 402,
//     "error": "User Payment Required"
// }

...

List Error Available In This Library

...
//for 4xx error
class BadRequestError extends OpsError { 
    static statusCode() { return 400 }; 
    static errorName() { return 'Bad Request Error'} 
};
class UnauthorizedError extends OpsError { 
    static statusCode() { return 401 }; 
    static errorName() { return 'Unauthorized Error'} 
};
class ForbiddenError extends OpsError { 
    static statusCode() { return 403 }; 
    static errorName() { return 'Forbidden Error'} 
};
class NotFoundError extends OpsError {
    static statusCode() { return 404 };
    static errorName() { return 'Not Found Error'}
};
class MethodNotAllowedError extends OpsError {
    static statusCode() { return 405 };
    static errorName() { return 'Method Not Allowed Error'}
};
class RequestTimeoutError extends OpsError {
    static statusCode() { return 408 };
    static errorName() { return 'Request Timeout Error'} };
class ConflictError extends OpsError {
    static statusCode() { return 409 };
    static errorName() { return 'Conflict Error'}
};
class UnsupportedMediaTypeError extends OpsError {
    static statusCode() { return 415 };
    static errorName() { return 'Unsupported Media Type Error'}
};
class UnprocessableEntityError extends OpsError {
    static statusCode() { return 422 };
    static errorName() { return 'Unprocessable Entity Error'}
};

//for 5xx error
class InternalServerError extends OpsError {
    static statusCode() { return 500 };
    static errorName() { return 'Internal Server Error'}
};
class NotImplementedError extends OpsError {
    static statusCode() { return 501 };
    static errorName() { return 'Not Implemented Error'}
};
class BadGatewayError extends OpsError {
    static statusCode() { return 502 };
    static errorName() { return 'Bad Gateway Error'}
};
class ServiceUnavailableError extends OpsError {
    static statusCode() { return 503 };
    static errorName() { return 'Service Unavailable Error'}
};

...

For other framework you can find code in example folder

Contact me : herudi7@gmail.com

Download Details:

Author: herudi

Source Code: https://github.com/herudi/ops-error

#nodejs #node #javascript