houston-errors v1.1.0

Houston-Errors, "we have a problem"

The Houston creates and returns a JavaScript Error, uses http errors and makes easy to add informations on it. (for while just in 400x, 500x, but you can create custom errors). All errors uses the same function called DefaultError which centralizes everything, that way makes easy handling errors. Also have an option to get default http errors objects by name, and from it get name, string and code. All errors are logged, and the best part is freedom to listen all errors and handle them by HoustonErrorEvents. It also have some integrations such as Sequelize.

Example of application (piece found over web)

app.get('/users/:id', (req, res) => {
  const userId = req.params.id
  if (!userId) {
    return res.sendStatus(400).json({
      error: 'Missing id'
    })
  }

  Users.get(userId, (err, user) => {
    if (err) {
      return res.sendStatus(500).json(err)
    }

    res.send(users)
  })
})

Using Houston

const { BadRequest } = require('houston-errors).houstonClientErrors;
const { InternalServerError } = require('houston-errors).houstonServerErrors;
app.get('/users/:id', (req, res) => {
  try {
	const userId = req.params.id
	if (!userId) { BadRequest({ message: 'Missing id' }); }
	Users.get(userId, (err, user) => {
	if (err) { InternalServerError({ data: err }); }
	res.send(users);
  } catch (error) {
      return res.sendStatus(error.code).json(error)
  }

• Houston
  • DefaultError(houstonError, [optionals])
    • Usage Example
  • CustomError([optionals])
    • Usage Example
  • HoustonErrorEvents
    • Usage Example
• HoustonClientErrors
  • Object Usage Example
  • Functions Usage Example
• HoustonServerErrors
  • Object Usage Example
  • Functions Usage Example
• Apollo13
  • Additional Messages
  • SequelizeError - Usage Example

Houston-Errors

All function listed above use on of DefaultError from houston-errors.

DefaultError(houstonError, optionals)

It will create a JS Error object, add name, code, error and the optionals (message, data). All the functions will returns the DefaultError.

• houstonError - Objects which can ben found in in houstonClientErrors, houstonServerErrors.
• optionals - optional object where: - message is a custom message which will be show in error.
  • data - additional error information (it can be object or string).

Usage Example

    const { DefaultError } = require('houston-errors').houston;
    const { BAD_REQUEST } = require('houston-errors').houstonClientErrors;
    const sendMessage = 'This is Houston. Say again, please';
    DefaultError(BAD_REQUEST, {
        message: sendMessage,
        data: '{Lousma: houston, we have a problem.}',
    });

CustomError(optionals)

It is also possible create your custom errors setting things like code, error, name, message and data.

• optionals - optional object where: - code is the code of error (default: 500). - error is the error type (default: Internal Server Error). - name the name of error (default: INTERNAL_SERVER_ERROR). - message is a custom message (default: if not defined it will be removed of object).
  • data - additional error information (it can be object or string, default: if not defined it will be removed of object).

Usage Example

    const { CustomError } = require('houston-errors').houston;
    const sendMessage = 'This is Houston. Say again, please';
    const lovellData = {lovell: 'We have had a MAIN B BUS UNDERVOLT'};
    const errorDef = 'houston, we have a problem';
    CustomError({
        code: 406,
        error: errorDef,
        name:'Lousma',
        message: sendMessage,
        data: lovellData,
    });

HoustonErrorEvents

You can also listen the HoustonErrorEvents which will emit all houstonError by the event 'weHaveAProblem' then handle it for whatever you want for a better custom application.

Usage Example

    const { HoustonErrorEvent } = require('houston-errors').houston;

    HoustonErrorEvent.on('weHaveAProblem', (error) => {
      //..code
    });

HoustonClientErrors

It is possible to import the the client errors by the name bellow and you get get any of them. They are an object with code, string and name.

Usage example

  const { NOT_FOUND } = require('houston-errors').houstonClientErrors;
  console.log(`code: ${NOT_FOUND.code}, name: ${NOT_FOUND.name}, error: ${NOT_FOUND.error} `);

It is also possible use functions which returns a JavaScript Error and contains keys like name, error, code, message and data. By default, those methods just returns code, name and error. The available functions are listed bellow.

All those functions above returns a DefaultError and have the structure like:

FunctionName(optionals)

• optionals - optional object where: - message is a custom message which will be show in error.
  • data - additional error information (it can be object or string).

Usage example

const { NotFound } = require('houston-errors').houstonClientErrors;

try {
    NotFound();
  } catch (error) {
    console.log(error.code)
  }

Setting message and data.

const { NotFound } = require('houston-errors').houstonClientErrors;

try {
    NotFound({message: 'custom message', data: 'some custom object or message'});
  } catch (error) {
    console.log(error.message);
  }

HoustonServerErrors

It is possible to import the the server errors by the name bellow and you get get any of them. They are an object with code, string and name.

Usage example

  const { INTERNAL_SERVER_ERROR } = require('houston-errors').houstonServerErrors;
  console.log(`code: ${INTERNAL_SERVER_ERROR.code}, name: ${INTERNAL_SERVER_ERROR.name}, error: ${INTERNAL_SERVER_ERROR.error} `);

It is also possible use functions which returns a JavaScript Error and contains keys like name, error, code, message and data. By default, those methods just returns code, name and error. The available functions are listed bellow.

All those functions above returns a DefaultError and have the structure like:

FunctionName(optionals)

• optionals - optional object where: - message is a custom message which will be show in error.
  • data - additional error information (it can be object or string).

Usage example

const { InternalServerError } = require('houston-errors').houstonServerErrors;

try {
    InternalServerError();
  } catch (error) {
    console.log(error.code)
  }

Setting message and data.

const { InternalServerError } = require('houston-errors').houstonServerErrors;

try {
    InternalServerError({message: 'custom message', data: 'some custom object or message'});
  } catch (error) {
    console.log(error.message);
  }

Apollo13

It is just an additional function and objects.

SequelizeError

If you use Sequelize, the basic of error will be integrated by function bellow.

SequelizeError, Usage Example

const { SequelizeError } = require('houston-errors').apollo13;
// Sequelize Model instance.
const User = require('../db/models/index').users;

try {
function createUser(userParams) {
  try {
    const params = userParams;
    const user = await User.create(params);
    return user;
  } catch (error) {
    // It will create an object Error; You must return if is in different paths.
    return SequelizeError(error);
  }