@flex-development/exceptions

exceptions

Exception data models

Overview

Getting Started
Installation
Usage
Contributing

Getting Started

Custom error class package designed to prevent repeating common exception data modelling patterns found in Flex Development projects.

The base class, Exception, is a subclass of the standard JavaScript Error object, and supports creating exceptions as well as converting Axios, Firebase, and Next.js error objects to Exception class errors.

The ExceptionJSON interface, a JSON representation of Exception, mimics error interfaces from @feathersjs/errors package, but with more opinionated type definitions.

Installation

yarn add @flex-development/exceptions # or npm i @flex-development/exceptions

Usage

import { ExceptionCode } from '@flex-development/exceptions/enums'
import Exception from '@flex-development/exceptions/exceptions/base.exception'

const dto = {
  email: '[e-mail]',
  password: '_securepassword'
}

const code = ExceptionCode.CONFLICT
const message = `User with email "${dto.email}" already exists`
const data = { dto, { errors: { email: dto.email } } }

const exception = new Exception(code, message, data)
const ejson = exception.toJSON()

console.error(exception.toJSON())

The log will contain object with the following shape:

const ejson: ExceptionJSON = {
  name: 'CONFLICT',
  message: 'User with email "[e-mail]" already exists',
  code: 409,
  className: 'conflict',
  data: { dto: { email: '[e-mail]', password: '_securepassword' } },
  errors: { email: '[e-mail]' }
}

For more details, view the Exception API documentation.