ip-custom-errors


A module that generates custom HTTP errors

setup

Install via npm:

``sh
npm i -S @financial-times/ip-custom-errors
`

Usage

The module exposes three methods to generate the custom HTTP errors. You can use the one that fits your needs as follows:

$3


`javascript
const { HTTPError } = require('@financial-times/ip-custom-errors');
try {
...
throw new HTTPError(401,'Unauthorized','You are not allowed to access this resource')
} catch (err) {
console.error(err)
}

`


$3

`javascript
const { HTTPStatusErrors } = require('@financial-times/ip-custom-errors');
try {
...
throw HTTPStatusErrors'400'
} catch (err) {
console.error(err)
}
`

$3


`javascript
const { NotFound } = require('@financial-times/ip-custom-errors');
try {
...
throw NotFound("The resource you requested can't be found");
} catch (err) {
console.error(err)
}
``
#### List of error names to use

||||
|:-----------------------------|:--------------------------|:-----------------------------|
| BadRequest | UnsupportedMediaType | NotImplemented |
| Unauthorized | RangeNotSatisfiable | BadGateway |
| PaymentRequired | Expectation | HttpVersionNotSupported |
| Forbidden | MisdirectedRequest | VariantAlsoNegotiates |
| NotFound | UnprocessableEntity | InsufficientStorage |
| MethodNotAllowed | Locked | LoopDetected |
| NotAcceptable | UnorderedCollection | NotExtended| |
| ProxyAuthenticationRequired | UpgradeRequired | NetworkAuthenticationRequired|
| RequestTimeout | PreconditionRequired | ServiceUnavailable |
| Conflict | TooManyRequests | GatewayTimeout |
| Gone | UnavailableForLegalReasons| BandwidthLimitExceeded |
| LengthRequired | InternalServerError |
| PreconditionFailed | ImATeapot |
| PayloadTooLarge | FailedDependency |
| UriTooLong | RequestHeaderFieldsTooLarge |

Licence

MIT