node-exceptions

Node Exceptions

Throwing errors in Javascript does not give much information about the error type as it is really hard to throw custom exceptions. Node Exceptions is a tiny wrapper which will let you extend the Error class and throw custom errors.

Why custom errors

Errors are thrown anywhere inside the code and handling them properly is required. For example you have an HTTP application, which can throw multiple errors and in order to handle those errors gracefully, you need to know the error types or their names.

switch (err.name) {
  case 'HttpException':
    // do something
  case 'RunTimeException':
    // do something else
}

Install

npm i --save node-exceptions

Creating custom errors

const NE = require('node-exceptions')

class MyCustomError extends NE.LogicalException {}

try {
  throw new MyCustomError('Something bad happened')
} catch (e) {
  console.log(e.status) // equals 500
  console.log(e.name) // equals MyCustomError
  console.log(e.message) // Something bad happened
  console.log(e.stack) // Error stack with correct reference to filepath and linenum
  console.log(e.toString()) // MyCustomError: Something bad happened
}

Custom error status

It is also possible to have a custom error status when throwing exceptions.

const NE = require('node-exceptions')

class HttpException extends NE.LogicalException {}

try {
  throw new HttpException('Page not found', 404)
} catch (e) {
  console.log(e.status) // equals 404
}

API Docs

Access complete API Docs here

Changelog

4.0.1 (2018-10-20)

<a name="4.0.0"></a>

Features

• message: only show errSh link if node env is development (#3) (ceaf9c5), closes #2
• rewrite: redo in typescript (c04e145)

BREAKING CHANGES

• rewrite: the 4th argument (errShLink) passed to the constructor now no longer prefixes the err.sh domain and expects a complete HTTP url

<a name="3.0.0"></a>