From 8417845955027d5918dd8ae63f22cf948c402362 Mon Sep 17 00:00:00 2001 From: Vadim Demedes Date: Sun, 17 Dec 2017 16:36:08 +0200 Subject: [PATCH] clarify accepted input of `error` option --- readme.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 7a8379d..eedfeec 100644 --- 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', {