feat: add toJSON method

src/types.ts

@@ -160,3 +160,15 @@ export type YouchANSIOptions = {
    */
   offset?: number
 }
+
+/**
+ * Set of options accepted by Youch when rendering error
+ * to JSON output
+ */
+export type YouchJSONOptions = {
+  /**
+   * Define the offset to skip certain stack frames from
+   * the top
+   */
+  offset?: number
+}

src/youch.ts

@@ -12,7 +12,7 @@ import type { Parser, SourceLoader, Transformer } from 'youch-core/types'
 
 import { Metadata } from './metadata.js'
 import { Templates } from './templates.js'
-import { YouchANSIOptions, YouchHTMLOptions } from './types.js'
+import { YouchANSIOptions, YouchHTMLOptions, YouchJSONOptions } from './types.js'
 
 /**
  * Youch exposes the API to render errors to HTML output
@@ -60,6 +60,14 @@ export class Youch {
     return this
   }
 
+  /**
+   * Parses error to JSON
+   */
+  async toJSON(error: unknown, options?: YouchJSONOptions) {
+    options = { ...options }
+    return new ErrorParser({ offset: options.offset }).parse(error)
+  }
+
   /**
    * Render error to HTML
    */