clarify accepted input of error option

vadimdemedes · Dec 17, 2017 · 8417845 · 8417845
1 parent 03ba2a9
commit 8417845
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/readme.md b/readme.md
@@ -80,9 +80,10 @@ Status of the test.
 
 ##### error
 
-Type: `Error`
+Type: `Error` `object`
 
-If test has failed (`passed` is `false`), `error` is an instance of an actual error.
+If test has failed (`passed` is `false`), `error` should be an instance of an actual error.
+It can also be an object, which fields will be included in the output (e.g. `name`, `message`, `actual`, `expected`).
 
 ```js
 supertest.test('failing', {