This package has been deprecated

Author message:

Package not maintained anymore. Use @icapps/tree-house-errors instead

tree-house-errors
TypeScript icon, indicating that this package has built-in type declarations

1.2.4 • Public • Published

Treehouse errors

Custom NodeJS error classes and definitions with an error parser utility function

npm version Dependencies Build Status Coverage Status Greenkeeper badge

Installation

Install via npm

npm install tree-house-errors

or via yarn

yarn add tree-house-errors

Error types

ApiError

Base error class which extends from the Error class.

// All keys are required
const error = {
  code: 'BAD_REQUEST_DUE_TO',
  message: 'This is a bad request',
}
 
// All keys are optional
const optionalArgs = {
  message: 'Overwrite the message for custom error',
  detail: 'Extra details containing pertinent information',
  stack: 'stacktrace...',
}
 
throw new ApiError(400, error, optionalArgs);

BadRequestError

extends from ApiError with a preset of status code 400 and BAD_REQUEST as error.

throw new BadRequestError(); // or
throw new BadRequestError(error, optionalArgs);

NotFoundError

extends from ApiError with a preset of status code 404 and RESOURCE_NOT_FOUND as error.

throw new NotFoundError(); // or
throw new NotFoundError(error, optionalArgs);

ForbiddenError

extends from ApiError with a preset of status code 403 and FORBIDDEN as error.

throw new ForbiddenError(); // or
throw new ForbiddenError(error, optionalArgs);

InternalServerError

extends from ApiError with a preset of status code 500 and INTERNAL_ERROR as error.

throw new InternalServerError(); // or
throw new InternalServerError(error, optionalArgs);

UnauthorizedError

extends from ApiError with a preset of status code 401 and UNAUTHORIZED as error.

throw new UnauthorizedError(); // or
throw new UnauthorizedError(error, optionalArgs);

ValidationError

extends from ApiError with a preset of status code 400 and INVALID_INPUT as error.

throw new ValidationError(); // or
throw new ValidationError(error, optionalArgs);

AuthenticationError

extends from ApiError with a preset of status code 400 and AUTHENTICATION_FAILED as error.

throw new AuthenticationError(); // or
throw new AuthenticationError(error, optionalArgs);

Error definitions

Predefined error types that can be used over multiple projects with a message and code per type. The current list provides following errors:

INTERNAL_ERROR:         { code: 'INTERNAL_ERROR',i18n: 'internal_error',message: 'An unkown error occurred' },
INVALID_INPUT:          { code: 'INVALID_INPUT', i18n: 'invalid_input', message: 'Invalid input provided' },
AUTHENTICATION_FAILED:  { code: 'AUTHENTICATION_FAILED', i18n: 'authentication_failed', message: 'Authentication failed' },
BAD_REQUEST:            { code: 'BAD_REQUEST', i18n: 'bad_request', message: 'Bad request' },
MISSING_HEADERS:        { code: 'MISSING_HEADERS', i18n: 'missing_headers', message: 'Missing headers' },
UNAUTHORIZED:           { code: 'UNAUTHORIZED', i18n: 'unauthorized', message: 'Unauthorized' },
FORBIDDEN:              { code: 'FORBIDDEN', i18n: 'forbidden', message: 'No access' },
RESOURCE_NOT_FOUND:     { code: 'RESOURCE_NOT_FOUND', i18n: 'resource_not_found', message: 'Resource not found' },

Example

import { errorConfig as errors } from 'tree-house-errors'
throw new ApiError(400, errors.BAD_REQUEST);

Error parsing

parseErrors(error, i18nOptions (optional))

Parse any data into an error object with all properties needed for jsonade parser. Also parses express-validation errors.

const error = new BadRequestError(...);
const parsedError = parseErrors(error);
 
// jsonade serializer afterwards (optional)
serializer.serialize([parsedError]);

With i18n support (optional):

const error = new BadRequestError(...);
const parsedError = parseErrors(error, {
  defaultLocale: 'en',          // Optional (defaults to 'en')
  language: 'nl',               // Optional (defaults to 'en')
  path: __dirname = '/locales',
});
 
// jsonade serializer afterwards (optional)
serializer.serialize([parsedError]);

The parseErrors function will load the i18n configuration once, and reuse the same instance afterwards. It is not possible to overwrite the configuration after the first call. This has to do with performance and caching of translations.

Tests

  • You can run yarn test to run all tests
  • You can run yarn test:coverage to run all tests with coverage report

Bugs

When you find issues, please report them:

Be sure to include all of the output from the npm command that didn't work as expected. The npm-debug.log file is also helpful to provide.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the ISC License - see the LICENSE.md file for details

Package Sidebar

Install

npm i tree-house-errors

Weekly Downloads

1

Version

1.2.4

License

ISC

Unpacked Size

46.1 kB

Total Files

24

Last publish

Collaborators

  • benjijanssens
  • samvanhoey
  • jaspervercammen
  • codeinineo
  • ethanfoust
  • jensicapps
  • willemhorsten
  • dgyesbreghs
  • samover
  • knor-el-snor