http-error-types
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

http-error-types

WEB (HTTP) Error Response Status Codes enumeration which includes an HttpError class extending the javascript Error class. Definintions are as per defined in Wikipedia (https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)

Installation

npm i http-error-types --save

Enums

  • clientErrorCodes - These are lists of globaly accepted server side error codes
  • serverErrorCodes - These are lists of globaly accepted server side error codes

Sample use

const s: clientErrorCodes = clientErrorCodes.badRequest;

if (s === 500 || a === clientErrorCodes.unauthorized) {
  console.log('test');
}

HttpError class

This class extends the default Javascript Error by adding 2 properties and a cutom constructor

try{
  throw new HttpError(clientErrorCodes.unauthorized, 'Please log-in first');
} catch(err) {
  // note in Typescript, we cannot define the type of catch err.
  // We can however manualy check if it derives from a certain class instance
  if (err instaceof HttpError) {
    console.log(`Error (${err.statusCode}) ${err.statusName}: ${err.message}`);
    // this prints out the following:
    // "Error (401) unauthorized: Please log-in first
  }
}

Constructor parameters

  • clientErrorCodes | serverErrorCodes - The first parameter is either one of the error code enumerations
  • message - The error message to send similar to new Error(message)

Class properties

  • statusCode - The numeric error code value
  • statusName - The human readable error code value

Readme

Keywords

Package Sidebar

Install

npm i http-error-types

Weekly Downloads

7

Version

1.0.1

License

MIT

Unpacked Size

9.9 kB

Total Files

6

Last publish

Collaborators

  • adonisv79