# @thermopylae/lib.exception

> General purpose exception.

Latest version **1.0.1** (published 2022-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @thermopylae/lib.exception
pnpm add @thermopylae/lib.exception
yarn add @thermopylae/lib.exception
bun add @thermopylae/lib.exception
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-05-29 |
| First published | 2021-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 16 |
| Dependencies | 0 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Rusu Marin |
| Maintainers | marinrusu1997 |
| Keywords | thermopylae, library, exception |

## Links

- npm: https://www.npmjs.com/package/@thermopylae/lib.exception
- Repository: https://github.com/marinrusu1997/thermopylae
- Homepage: https://github.com/marinrusu1997/thermopylae#readme
- Issues: https://github.com/marinrusu1997/thermopylae/issues
- npm.io page: https://npm.io/package/@thermopylae/lib.exception

## Recent versions

- 1.0.1 (latest) — 2022-05-29
- 1.0.0 — 2022-05-29
- 0.0.1 — 2021-08-10

## README

<h1 align="center">@thermopylae/lib.exception</h1>
<p>
  <img alt="Version" src="https://img.shields.io/badge/version-0.0.1-blue.svg?cacheSeconds=2592000" />
  <img alt="Node Version" src="https://img.shields.io/badge/node-%3E%3D16-blue.svg"/>
<a href="https://marinrusu1997.github.io/thermopylae/lib.exception/index.html" target="_blank">
  <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<a href="https://github.com/marinrusu1997/thermopylae/blob/master/LICENSE" target="_blank">
  <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
</a>
</p>

> General purpose exception.

## Install

```sh
npm install @thermopylae/lib.exception
```

## Description
This package contains [Exception][exception-link] class.

## Usage
```typescript
import { Exception } from '@thermopylae/lib.exception';

function throwable() {
    throw new Exception('EMITTER', 'ERROR_CODE', 'ERROR_MESSAGE', {
        'meaningfull-data': 'error-context' 
    });
}

throwable();
```

## API Reference
API documentation is available [here][api-doc-link].

It can also be generated by issuing the following commands:
```shell
git clone git@github.com:marinrusu1997/thermopylae.git
cd thermopylae
yarn install
yarn workspace @thermopylae/lib.exception run doc
```

## Author
👤 **Rusu Marin**

* GitHub: [@marinrusu1997](https://github.com/marinrusu1997)
* Email: [dimarusu2000@gmail.com](mailto:dimarusu2000@gmail.com)
* LinkedIn: [@marinrusu1997](https://www.linkedin.com/in/rusu-marin-1638b0156/)

## 📝 License
Copyright © 2021 [Rusu Marin](https://github.com/marinrusu1997). <br/>
This project is [MIT](https://github.com/marinrusu1997/thermopylae/blob/master/LICENSE) licensed.

[api-doc-link]: https://marinrusu1997.github.io/thermopylae/lib.exception/index.html
[exception-link]: https://marinrusu1997.github.io/thermopylae/lib.exception/classes/exception.html

---
_Source: https://npm.io/package/@thermopylae/lib.exception · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._