0.0.2 • Published 5 years ago

@bloxdrive/httperrorhandler v0.0.2

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
5 years ago

httperrorhandler

This module was created for use in BloxDrive. However, you may use the package in your own projects.

What is it?

The module is basically just a means of converting a http error value (ie. 404) to a more freindly and easy to use JavaScript object. This object includes attributes such as a title and a message.

When you do:

const httpErr = require('@bloxdrive/httperrorhandler');

let httpErrorReturn = httpErr(404);     // Where 404 is the error you are inputing
console.log(httpErrorReturn);

You will get this in return:

{
    "title": "Page Not Found",
    "message": "The page you were looking for does not exist."
}

I want to add/remove/change error responses in some way!

You can modify error_list.json within the modules folder that resides in node_modules. It looks like this by default:

{
  "204": {
    "title": "There's no content here!",
    "message": "The page you were looking for exists, but there is nothing to show."
  },
  "400": {
    "title": "Bad Request.",
    "message": "Something wrong happened on your end."
  },
  "401": {
    "title": "Please login before viewing this.",
    "message": "You are either not logged in or do not have the correct credentials to view this."
  },
  "402": {
    "title": "Premium Content.",
    "message": "The content you are trying to access is for premium users only."
  },
  "403": {
    "title": "Forbidden.",
    "message": "You are not allowed to access this. Sorry."
  },
  "404": {
    "title": "Page not found.",
    "message": "The page you were looking for does not exist."
  },
  "408": {
    "title": "Timeout.",
    "message": "The internet took to long to send your request."
  },
  "410": {
    "title": "Gone.",
    "message": "The page you were looking for was removed."
  },
  "500": {
    "title": "Server Error.",
    "message": "The server made a mistake... That's all we know."
  },
  "503": {
    "title": "Server Error.",
    "message": "The server made a mistake... That's all we know."
  },
  "default": {
    "title": "An error occured.",
    "message": "We arn't exactly sure what happened here."
  }
}

The default response is essentially a catch all that will occur when the error provided is not listed.