README.md

exceptions

Custom error classes and utilities.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
  • Data Transfer Objects
  • Enums
  • Interfaces
  • Type Definitions
• Contribute

What is this?

This package exports a set of custom error classes and utilities.

When should I use this?

TODO: Update documentation.

Install

yarn add @flex-development/exceptions

From Git:

yarn add @flex-development/exceptions@flex-development/exceptions

See Git - Protocols | Yarn  for details on requesting a specific branch, commit, or tag.

Use

TODO: usage documentation.

API

TODO: api documentation.

Types

This package is fully typed with TypeScript.

Data Transfer Objects

• ExceptionDTO
• HttpExceptionDTO

Enums

• ClassName
• StatusName
• Status

Interfaces

• ExceptionJSON
• HttpExceptionJSON

Type Definitions

• Errors

Contribute

See CONTRIBUTING.md.