From abcca633cf67d7b9c461a7b496f499598184242a Mon Sep 17 00:00:00 2001 From: Aliaksei Shytkin Date: Thu, 7 Jan 2016 10:29:07 +0300 Subject: [PATCH] Add Internals section to README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 59aa63f..c09804c 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,25 @@ module.exports = function(config) { The `grep` argument is passed directly to mocha. +## Internals + +On the end of each test `karma-mocha` passes to `karma` result object with fields: + +* `description` Test title. +* `suite` List of titles of test suites. +* `success` True if test is succeed, false otherwise. +* `skipped` True if test is skipped. +* `time` Test duration. +* `log` List of errors. +* `assertionErrors` List of additional error info: + * `name` Error name. + * `message` Error message. + * `actual` Actual data in assertion, serialized to string. + * `expected` Expected data in assertion, serialized to string. + * `showDiff` True if it is configured by assertion to show diff. + +This object will be passed to test reporter. + ----