xcore-express

A lightweight library that brings middlewares to handle error reporting in web applications using Node and Express.

xcore-express

A lightweight library that brings middlewares to handle error reporting in web applications using Node and Express.

A reference guide to middlewares and helper functions included in xcore.

Exception Classes

Class NameDescriptionDefault Message
ExceptionThe exception that is thrown when an error occurs.No Description
ArgumentExceptionThe exception that is thrown when one of the arguments provided to a method is not valid.Invalid Argument
InvalidInputExceptionThe exception that is thrown when one of the input provided to a method is not valid.Invalid Input
NotImplementedExceptionThe exception that is thrown when a requested method or operation is not implemented.Not Implemented
NotSupportedExceptionThe exception that is thrown when a requested method or operation is not supported.Not Supported
NotFoundExceptionThe exception that is thrown when an attempt is made to find something that does not exist.Not Found
UnauthenticatedExceptionThe exception that is thrown when a requested method or operation requires authentication.Not Authenticated
UnauthorizedExceptionThe exception that is thrown when the current user is not allowed to perform an attempted operation.Not Authorized

A middleware to detect error type and send a JSON response with approperiate HTTP Status code and message.

Usage:

if (!req.isAuthenticated()) {
  throw new UnauthenticatedException("Authentication is required.");
}

Example response:

{
  "meta": {
    "code": 401,
    "success": false,
    "message": "Authentication is required."
  }
}

A middleware to format and log errors to console.

Sample console log:

>> GET /api/users/me
>> [UnauthenticatedException] Authentication is required.
>> [Error]
>> ... stack trace ...

xcore-express is released under the MIT license. See LICENSE for details.