diff --git a/docs/index.md b/docs/index.md index 5dac9ff173..6e692ec13b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1574,6 +1574,16 @@ mocha.setup({ }); ``` +Some available options: + +```text +reporter {string|constructor} - Reporter** name or constructor. +ui {string} - Interface name. +useColors {boolean} - Use color TTY output from reporter? +``` + +\*\* Available built in reporters that can be referenced by name [here](#reporters), and recommended reporters for the browser [here](#reporting). + ### Browser-specific Option(s) The following option(s) _only_ function in a browser context: @@ -1582,7 +1592,7 @@ The following option(s) _only_ function in a browser context: ### Reporting -The "HTML" reporter is what you see when running Mocha in the browser. It looks like this: +The "HTML" reporter is the default reporter when running Mocha in the browser. It looks like this: ![HTML test reporter](images/reporter-html.png?withoutEnlargement&resize=920,9999){:class="screenshot" lazyload="on"} diff --git a/lib/mocha.js b/lib/mocha.js index 6c8bf2561b..e9077b926f 100644 --- a/lib/mocha.js +++ b/lib/mocha.js @@ -70,7 +70,6 @@ exports.Test = require('./test'); * @param {boolean} [options.asyncOnly] - Force `done` callback or promise? * @param {boolean} [options.bail] - Bail after first test failure? * @param {boolean} [options.checkLeaks] - Check for global variable leaks? - * @param {boolean} [options.color] - Color TTY output from reporter? * @param {boolean} [options.delay] - Delay root suite execution? * @param {boolean} [options.diff] - Show diff on failure? * @param {string} [options.fgrep] - Test filter given string. @@ -83,12 +82,13 @@ exports.Test = require('./test'); * @param {boolean} [options.inlineDiffs] - Display inline diffs? * @param {boolean} [options.invert] - Invert test filter matches? * @param {boolean} [options.noHighlighting] - Disable syntax highlighting? - * @param {string} [options.reporter] - Reporter name. + * @param {string|constructor} [options.reporter] - Reporter name or constructor. * @param {Object} [options.reporterOption] - Reporter settings object. * @param {number} [options.retries] - Number of times to retry failed tests. * @param {number} [options.slow] - Slow threshold value. * @param {number|string} [options.timeout] - Timeout threshold value. * @param {string} [options.ui] - Interface name. + * @param {boolean} [options.useColors] - Use color TTY output from reporter? */ function Mocha(options) { options = utils.assign({}, mocharc, options || {});