# @nuxtjs/youch

> Pretty error reporting for Node.js 🚀 (Modified for Nuxt.js & SSR Bundles)

Latest version **4.2.3** (published 2018-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nuxtjs/youch
pnpm add @nuxtjs/youch
yarn add @nuxtjs/youch
bun add @nuxtjs/youch
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.3 |
| Published | 2018-01-07 |
| First published | 2017-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 29 |
| Author | amanvirk |
| Maintainers | alexchopin, atinux, pi0 |
| Keywords | errors, error-reporting, whoops |

## Links

- npm: https://www.npmjs.com/package/@nuxtjs/youch
- Repository: https://github.com/nuxt/youch
- Homepage: https://github.com/poppinss/nuxt#readme
- Issues: https://github.com/poppinss/nuxt/issues
- npm.io page: https://npm.io/package/@nuxtjs/youch

## Dependencies (3)

- [cookie](https://npm.io/package/cookie.md) ^0.3.1
- [mustache](https://npm.io/package/mustache.md) ^2.3.0
- [stack-trace](https://npm.io/package/stack-trace.md) 0.0.10

## 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

- 4.2.3 (latest) — 2018-01-07
- 2.0.5 (test) — 2017-08-04
- 4.2.2 — 2018-01-07
- 4.2.1 — 2018-01-06
- 4.2.0 — 2018-01-06
- 4.1.0 — 2018-01-06
- 4.0.1 — 2018-01-04
- 4.0.0 — 2018-01-04
- 3.1.0 — 2017-09-09
- 3.0.2 — 2017-08-17
- 3.0.1 — 2017-08-04
- 3.0.0 — 2017-08-04

## README

# Youch!
> Pretty error reporting for Node.js 🚀 (Modified for Nuxt.js & SSR Bundles)

<br />

<p>
    <img src="https://user-images.githubusercontent.com/5158436/28990900-0a4766f8-7997-11e7-9f0b-4336fa2e2e0b.png" style="width: 600px;" />
</p>

<br />

---

<br />

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]
[![Appveyor][appveyor-image]][appveyor-url]

[![Gitter Channel][gitter-image]][gitter-url]
[![Trello][trello-image]][trello-url]
[![Patreon][patreon-image]][patreon-url]

Youch is inspired by [Whoops](https://filp.github.io/whoops) but with a modern design. Reading stack trace of the console slows you down from active development. Instead **Youch** print those errors in structured HTML to the browser.

## Features
1. HTML reporter
2. JSON reporter, if request accepts a json instead of text/html.
3. Sorted frames of error stack.

## Installation
```bash
npm i --save @nuxtjs/youch
```

## Basic Usage
Youch is used by [AdonisJs](http://adonisjs.com) and [Nuxt.js](https://nuxtjs.org), but it can be used by express or raw HTTP server as well.

```javascript
const Youch = require('@nuxtjs/youch')
const http = require('http')

http.createServer(function (req, res) {

  // PERFORM SOME ACTION
  if (error) {
    const youch = new Youch(error, req)

    youch
    .toHTML()
    .then((html) => {
      res.writeHead(200, {'content-type': 'text/html'})
      res.write(html)
      res.end()
    })
  }

}).listen(8000)
```

## Release History
Checkout [CHANGELOG.md](CHANGELOG.md) file for release history.

## Meta
Checkout [LICENSE.txt](LICENSE.txt) for license information
Harminder Virk (Aman) - [https://github.com/thetutlage](https://github.com/thetutlage)


[appveyor-image]: https://ci.appveyor.com/api/projects/status/github/nuxt/youch?branch=master&svg=true&passingText=Passing%20On%20Windows
[appveyor-url]: https://ci.appveyor.com/project/nuxt/youch

[npm-image]: https://img.shields.io/npm/v/@nuxtjs/youch.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@nuxtjs/youch

[travis-image]: https://img.shields.io/travis/nuxt/youch/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/nuxt/youch

[gitter-url]: https://gitter.im/adonisjs/adonis-framework
[gitter-image]: https://img.shields.io/badge/gitter-join%20us-1DCE73.svg?style=flat-square

[trello-url]: https://trello.com/b/yzpqCgdl/adonis-for-humans
[trello-image]: https://img.shields.io/badge/trello-roadmap-89609E.svg?style=flat-square

[patreon-url]: https://www.patreon.com/adonisframework
[patreon-image]: https://img.shields.io/badge/patreon-support%20AdonisJs-brightgreen.svg?style=flat-square

[npm-downloads]: https://img.shields.io/npm/dm/@nuxtjs/youch.svg?style=flat-square

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