Different HTTP Response Error classes
A collection of HTTP Response error classes
``
$ npm install @infotorg/http-response-error
`javascript
// Create a new error only with a status code using ResponseErrorFactory
import { ResponseErrorFactory } from '@infotorg/http-response-error';
const error = ResponseErrorFactory.create({ code: 404 });
console.log(error.toJSON());
// {
// error: {
// code: 404,
// requestId: '',
// message: 'Not Found',
// details: ''
// }
// }
console.log(error.status);
// 404 Not Found
console.log(error.code);
// 404
console.log(error.message);
// Not Found
`
`javascript
// Create a new error with all possible options using ResponseErrorFactory
import { ResponseErrorFactory } from '@infotorg/http-response-error';
const error = ResponseErrorFactory.create({
code: 404,
requestId: '123456-test-request-id',
message: 'Nothing found',
details: 'Some details about error',
});
console.log(error.toJSON());
// {
// error: {
// code: 404,
// requestId: '123456-test-request-id',
// message: 'Nothing found',
// details: 'Some details about error'
// }
// }
console.log(error.status);
// 404 Noting Found
console.log(error.code);
// 404
console.log(error.message);
// Nothing found
console.log(error.details);
// Some details about error
`
`javascript
// Create a new specifyed error without options
import { TooManyRequestsError } from '@infotorg/http-response-error';
const error = new TooManyRequestsError();
console.log(error.toJSON());
// {
// error: {
// code: 429,
// requestId: '',
// message: 'Too Many Requests',
// details: ''
// }
// }
console.log(error.status);
// 429 Too Many Requests
console.log(error.code);
// 429
console.log(error.message);
// Too Many Requests
`
`javascript
// Create a new specifyed error with message only
import { TooManyRequestsError } from '@infotorg/http-response-error';
const error = new TooManyRequestsError('Rate limit exceeded');
console.log(error.toJSON());
// {
// error: {
// code: 429,
// requestId: '',
// message: 'Rate limit exceeded',
// details: ''
// }
// }
console.log(error.status);
// 429 Rate limit exceeded
console.log(error.code);
// 429
console.log(error.message);
// Rate limit exceeded
`
`javascript
// Create a new specifyed error with options
import { TooManyRequestsError } from '@infotorg/http-response-error';
const error = new TooManyRequestsError({
code: 429,
message: 'Rate limit exceeded',
requestId: requestId(),
details: 'Please, contact our support https://support.example.com',
});
console.log(error.toJSON());
// {
// error: {
// code: 429,
// requestId: '123456-test-request-id',
// message: 'Rate limit exceeded',
// details: 'Please, contact our support https://support.example.com'
// }
// }
console.log(error.status);
// 429 Rate limit exceeded
console.log(error.code);
// 429
console.log(error.message);
// Rate limit exceeded
console.log(error.details);
// Please, contact our support https://support.example.com
`
Tests are written with jest. They can be run with npm:
`
npm run test
##### LICENSE: MIT
##### AUTHOR: Volodymyr Chumak