feat: serialize error cause and help properties

poppinss · Feb 7, 2023 · 1254c6c · 1254c6c
1 parent 0c43729
commit 1254c6c
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -31,6 +31,8 @@ declare module "youch" {
       error: {
         message: string;
         name: string;
+        cause?: any;
+        help?: any;
         status: number;
         frames: {
           file: string;

diff --git a/src/Youch.js b/src/Youch.js
@@ -240,6 +240,8 @@ class Youch {
     callback = callback || this._serializeFrame.bind(this)
     return {
       message: this.error.message,
+      help: this.error.help,
+      cause: this.error.cause,
       name: this.error.name,
       status: this.error.status,
       frames:

diff --git a/test/youch.spec.js b/test/youch.spec.js
@@ -213,4 +213,32 @@ test.group('Youch', () => {
       })
       .catch(done)
   })
+
+  test('serialize error cause', (assert, done) => {
+    const cause = new Error('The main error')
+    const error = new Error('foo', { cause })
+    const youch = new Youch(error, {})
+    youch
+      .toJSON()
+      .then(({ error }) => {
+        assert.equal(error.frames[0].filePath, __filename.replace(/\\/g, '/'))
+        assert.equal(error.frames[0].isNative, false)
+        assert.strictEqual(error.cause, cause)
+        done()
+      }).catch(done)
+  })
+
+  test('serialize error help', (assert, done) => {
+    const error = new Error('foo')
+    error.help = ['This is the error help text']
+    const youch = new Youch(error, {})
+    youch
+      .toJSON()
+      .then(({ error }) => {
+        assert.equal(error.frames[0].filePath, __filename.replace(/\\/g, '/'))
+        assert.equal(error.frames[0].isNative, false)
+        assert.deepEqual(error.help, ['This is the error help text'])
+        done()
+      }).catch(done)
+  })
 })
diff --git a/test/youch.spec.mjs b/test/youch.spec.mjs
@@ -218,4 +218,32 @@ test.group('Youch | ESM', () => {
       })
       .catch(done)
   })
+
+  test('serialize error cause', (assert, done) => {
+    const cause = new Error('The main error')
+    const error = new Error('foo', { cause })
+    const youch = new Youch(error, {})
+    youch
+      .toJSON()
+      .then(({ error }) => {
+        assert.equal(error.frames[0].filePath, __filename.replace(/\\/g, '/'))
+        assert.equal(error.frames[0].isNative, false)
+        assert.strictEqual(error.cause, cause)
+        done()
+      }).catch(done)
+  })
+
+  test('serialize error help', (assert, done) => {
+    const error = new Error('foo')
+    error.help = ['This is the error help text']
+    const youch = new Youch(error, {})
+    youch
+      .toJSON()
+      .then(({ error }) => {
+        assert.equal(error.frames[0].filePath, __filename.replace(/\\/g, '/'))
+        assert.equal(error.frames[0].isNative, false)
+        assert.deepEqual(error.help, ['This is the error help text'])
+        done()
+      }).catch(done)
+  })
 })