\n\n \n\n---\n\n \n\n[![NPM Version][npm-image]][npm-url]\n[![Tests][gh-workflow-image]][gh-workflow-url]\n[![Downloads Stats][npm-downloads-image]][npm-url]\n\nYouch 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.\n\n## Features\n1. HTML reporter\n2. JSON reporter, if request accepts a json instead of text/html.\n3. Sorted frames of error stack.\n4. Support for ESM.\n\n> Checkout [youch terminal](https://github.com/poppinss/youch-terminal) to beautify errors on terminal.\n\n## Installation\n```bash\nnpm i --save youch\n```\n\n## Basic Usage\nYouch is used by [AdonisJs](http://adonisjs.com), but it can be used by express or raw HTTP server as well.\n\n```javascript\nconst Youch = require('youch')\nconst http = require('http')\n\nhttp.createServer(async function (req, res) {\n\n // PERFORM SOME ACTION\n if (error) {\n const youch = new Youch(error, req)\n const html = await youch.toHTML()\n\n res.writeHead(200, {'content-type': 'text/html'})\n res.write(html)\n res.end()\n }\n\n}).listen(8000)\n```\n\n## Adding helpful links\nEverytime an error occurs, we can help users we letting search for the error on Google, over even on the Github repo of our project. \n\nYouch let you define clickable links to redirect the user to a website with the error message.\n\n```js\nconst youch = new Youch(error)\n\nawait youch\n .addLink(({ message }) => {\n const url = `https://stackoverflow.com/search?q=${encodeURIComponent(`[adonis.js] ${message}`)}`\n \n return `Search stackoverflow`\n })\n .toHTML()\n``` \n\nAlso you can make use of [Font awesome brands icons](https://fontawesome.com/icons?d=gallery&s=brands&m=free) to display icons. \n\n**If you will use fontawesome icons, then Youch will automatically load the CSS files from the font awesome CDN for you.**\n\n```js\nconst youch = new Youch(error)\n\nawait youch\n .addLink(({ message }) => {\n const url = `https://stackoverflow.com/search?q=${encodeURIComponent(`[adonis.js] ${message}`)}`\n return ``\n })\n .toHTML()\n```\n\n## Toggle show all frames checkbox\nWhen rendering HTML you can call the `toggleShowAllFrames` method to check/uncheck the show all frames checkbox.\n\nBy default, the checkbox is not checked and calling this method once will toggle the state.\n\n```js\nconst youch = new Youch(error)\n\nawait youch\n .toggleShowAllFrames()\n .toHTML()\n```\n\n## Get stack as JSON\nYou can also the error stack frames as JSON by calling the `.toJSON` method.\n\n```js\nconst youch = new Youch(error, {})\nconst jsonResponse = await youch.toJSON()\n```\n\nFollowing is the shape of the `toJSON` return data type.\n\n```ts\ntype JsonResponse = {\n error: {\n message: string;\n name: string;\n status: number;\n frames: {\n file: string,\n filePath: string,\n line: number,\n column: number,\n callee: string,\n calleeShort: string,\n context: {\n start: number,\n pre: string,\n line: string,\n post: string,\n },\n isModule: boolean,\n isNative: boolean,\n isApp: boolean\n }[];\n };\n}\n```\n\n## Release History\nCheckout [CHANGELOG.md](CHANGELOG.md) file for release history.\n\n## Meta\nCheckout [LICENSE.md](LICENSE.md) for license information\nHarminder Virk (Aman) - [https://github.com/thetutlage](https://github.com/thetutlage)\n\n[gh-workflow-image]: https://img.shields.io/github/workflow/status/poppinss/youch/test?style=for-the-badge\n[gh-workflow-url]: https://github.com/poppinss/youch/actions/workflows/test.yml \"Github action\"\n\n[npm-image]: https://img.shields.io/npm/v/youch.svg?style=for-the-badge&logo=npm\n[npm-url]: https://npmjs.org/package/youch 'npm'\n\n[npm-downloads-image]: https://img.shields.io/npm/dm/youch.svg?style=for-the-badge\n","readmeFilename":"README.md"}
![](\"youch.jpeg\")
\n \n