kbariotis / throw.js Goto Github PK

View Code? Open in Web Editor NEW

274.0 5.0 18.0 57 KB

HTTP Error collection to use in your next REST API.

License: MIT License

TypeScript 100.00%

javascript nodejs errors

throw.js's Introduction

throw.js

An HTTP Error collection to use in your next REST API.

Installation

npm install --save throw.js

yarn add throw.js

Example

const express = require("express");
const app = express();
const { NotFound } = require("throw.js");
const logger = require("winston");

app.get("/", (req, res, next) => {
    next(new NotFound());
});

app.use((err, req, res, next) => {
    logger.error(err);

    if (req.app.get("env") !== "development" && req.app.get("env") !== "test") {
        delete err.stack;
    }

    res.status(err.statusCode || 500).json(err);
});

app.listen(3000);

Custom Errors

const { CustomError } = require("throw.js");

throw new CustomError(message, statusCode?, errorCode?, originalError?);

Parameters:

message[optional]: Detailed message of this error
statusCode[optional]: The HTTP Status number to return
errorCode[optional]: An internal unique code identifier of this error

Stacking Errors

const { CustomError } = require("throw.js");

try {
    // throws an error
} catch (e) {
    // Pass the error as a parameter to keep its original stack trace
    throw new CustomError(message, statusCode, errorCode, e);
}

Errors

All of the classes below have all parameters set up by default, based on RFC7231. But you can override the message and the errorCode to fit your for personal needs.

400 Bad Request

BadRequest(message?, errorCode?, originalError?);

401 Unauthorized

Unauthorized(message?, errorCode?, originalError?);

402 Payment Required

PaymentRequired(message?, errorCode?, originalError?);

403 Forbidden

Forbidden(message?, errorCode?, originalError?);

404 Not Found

NotFound(message?, errorCode?, originalError?);

405 Method Not Allowed

MethodNotAllowed(message?, errorCode?, originalError?);

406 Not Acceptable

NotAcceptable(message?, errorCode?, originalError?);

407 Proxy Authentication Required

ProxyAuthenticationRequired(message?, errorCode?, originalError?);

408 Request Timeout

RequestTimeout(message?, errorCode?, originalError?);

409 Conflict

Conflict(message?, errorCode?, originalError?);

410 Gone

Gone(message?, errorCode?, originalError?);

422 Unprocessable Entity

UnprocessableEntity(message?, errorCode?, originalError?);

424 Failed Dependency

FailedDependency(message?, errorCode?, originalError?);

500 Internal Server Error

InternalServerError(message?, errorCode?, originalError?);

501 Not Implemented

NotImplemented(message?, errorCode?, originalError?);

502 Bad Gateway

BadGateway(message?, errorCode?, originalError?);

503 Service Unavailable

ServiceUnavailable(message?, errorCode?, originalError?);

504 Gateway Timeout

GatewayTimeout(message?, errorCode?, originalError?);

505 HTTP Version Not Supported

HttpVersionNotSupported(message?, errorCode?, originalError?);

511 Network Authentication Required

NetworkAuthenticationRequired(message?, errorCode?, originalError?);

TODO

Implement more Error Classes

throw.js's People

Contributors

Stargazers

Watchers

Forkers

phuson sigh0829 ribeiro tyao1 swampthingmedia reesilva mitchellporter amritpal33 lipis lavinia-dan ivorocha90 lpham-tech sachinshelke gitboo wchopite nicksp fusiongalaxy

throw.js's Issues

2.1.0 name changes are a breaking change over 2.0.0

I'm getting a lot of error messages that look like:

throwjs.notFound is not a function

😞
It might be worthwhile reverting for a 2.2.0 release and rerelease the change with a new major version 3.0.0. Though I'll probably just lock down on 2.0.0 for now.

New throw.js version on npm?

Quick question, will there be a new version on npm for throw.js that includes this commit? bfce471

Thanks!

Error "message" not serialized by Express and not returned

Hello,

in the example code the error middleware returns the error like this:

res.status(err.statusCode || 500).json(err);

Unfortunately .json() doesn't serialize the error object returned by throw.js. The returned JSON in this example would be:

{
    "name": "NotFound",
    "statusCode": 404,
    "errorCode": 404
}

The "message"-property is missing.

Solution: To return the complete error object (including "message"-property) I use this instead:

res.set({ 'content-type': 'application/json' }).status(err.statusCode || 500).send(JSON.stringify(err, Object.getOwnPropertyNames(err)))

Source

Can this JSON serialization behaviour maybe implemented in throw.js?