modified

2026-06-20 05:42:08 +02:00 · 2023-11-24 22:35:41 +01:00
parent 3c0b507a93
commit 7644b2a0f7
45165 changed files with 4803356 additions and 3 deletions
@@ -0,0 +1,43 @@
+# Youch terminal
+
+![](youch-terminal.jpeg)
+
+This package converts the [youch](https://npmjs.com/package/youch) error message to a string to be displayed on terminal. The output of the function is colorized using [chalk](https://npmjs.com/package/chalk).
+
+## Install
+```
+npm i youch-terminal
+```
+
+## Usage
+Make sure you pass the output `toJSON` to the youch terminal function.
+
+```js
+const Youch = require('youch')
+const forTerminal = require('youch-terminal')
+
+const error = new Error('Some weird error')
+const jsonResponse = await new Youch(error, {}).toJSON()
+
+const options = {
+  // Defaults to false
+  displayShortPath: false,
+
+  // Defaults to single whitspace
+  prefix: ' ',
+
+  // Defaults to false
+  hideErrorTitle: false,
+
+  // Defaults to false
+  hideMessage: false,
+
+  // Defaults to false
+  displayMainFrameOnly: false,
+
+  // Defaults to 3
+  framesMaxLimit: 3,
+}
+
+console.log(forTerminal(output, options))
+```