throw.js

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

Installation

``
npm install --save throw.js
`

or

`
yarn add throw.js
`

Example

`javascript
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

`javascript
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

`javascript
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.

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

TODO

- Implement more Error Classes