A library that provides extensible ES6 HTTP error classes.
npm install @ebec/http
A library that provides extensible ES6 HTTP error classes that define basic information about the error.
Table of Contents
- Installation
- Usage
- Classes
- Base
- Client
- Server
- Utils
- License
``bash`
npm install @ebec/http --save
The usage is pretty easy, just import one of the client or server error classes and use them
in throw- & catch- statements.
Basic
`typescript
import {
InternalServerError,
NotFoundError
} from "@ebec/http";
const clientError = new NotFoundError();
console.log(clientError.statusCode);
// 404
console.log(clientError.logMessage);
// false
console.log(clientError.code);
// NOT_FOUND
// ------------------------------------
const serverError = new InternalServerError({
logLevel: 'warning'
});
console.log(clientError.statusCode);
// 500
console.log(clientError.logMessage);
// true
console.log(clientError.code);
// INTERNAL_SERVER_ERROR
console.log(clientError.logLevel);
// warning
`
Another way to use the predefined error classes is to extend them,
with own options.
Extend
`typescript
import {
Options,
mergeOptions,
NotFoundError
} from "@ebec/http";
class UserNotFound extends NotFoundError {
constructor() {
super({
statusMessage: 'The user was not found.',
code: 'USER_NOT_FOUND'
});
}
}
`
The following HTTP classes are predefined:
- HTTPError
-
-
- 400 BadRequestError
- 401
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 420
- 422
- 423
- 424
- 424
- 426
- 428
- 429
- 431
- 444
- 449
- 450
- 499
- 500 InternalServerError
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
This method determines whether it is a client or server error.
`typescript
import { isHTTPError, NotFoundError } from "@ebec/http";
const error = new NotFoundError();
console.log(isHTTPError(error));
// true
`
This method determines whether it is a client error.
`typescript
import { isClientError, NotFoundError } from "@ebec/http";
const error = new NotFoundError();
console.log(isClientError(error));
// true
`
This method determines whether it is a server error.
`typescript
import { isServerError, NotFoundError } from "@ebec/http";
const error = new NotFoundError();
console.log(isServerError(error));
// false
``
Made with 💚
Published under MIT License.