# shout-error

> An opinionated error message

Latest version **1.0.4** (published 2020-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install shout-error
pnpm add shout-error
yarn add shout-error
bun add shout-error
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2020-07-17 |
| First published | 2017-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Bu Kinoshita |
| Maintainers | bukinoshita |
| Keywords | message, error, shout, console, handler |

## Links

- npm: https://www.npmjs.com/package/shout-error
- Repository: https://github.com/bukinoshita/shout-error
- npm.io page: https://npm.io/package/shout-error

## Dependencies (1)

- [chalk](https://npm.io/package/chalk.md) 4.1.0

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.0.4 (latest) — 2020-07-17
- 1.0.3 — 2020-05-08
- 1.0.2 — 2020-04-29
- 1.0.1 — 2020-04-27
- 1.0.0 — 2020-02-23
- 0.0.2 — 2017-07-08
- 0.0.1 — 2017-06-18

## README

# shout-error [![Build Status](https://travis-ci.org/bukinoshita/shout-error.svg?branch=master)](https://travis-ci.org/bukinoshita/shout-error)

> An opinionated error message

<img src="demo.png" width="500" />

## Install

```
$ yarn add shout-error
```

## Usage

```js
const { shoutError } = require('shout-error')

const error = new TypeError('Ops, something wrong happened')

shoutError(error)
```

_Uses [chalk](https://github.com/chalk/chalk), will return a error message with a nice color._

## API

### shoutError(message, label)

#### message

Type: `string` or [`instanceof Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) or [`instanceof TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError)<br>
Required

#### label

Type: `string`<br>
Default: `> Error!`

## Related

- [shout-message](https://github.com/bukinoshita/shout-message) — An opinionated message
- [shout-success](https://github.com/bukinoshita/shout-success) — An opinionated success message

## License

MIT © [Bu Kinoshita](https://bukinoshita.com)

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