diff --git a/docs/index.md b/docs/index.md index 5dac9ff173..da95569004 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1576,13 +1576,22 @@ mocha.setup({ ### Browser-specific Option(s) -The following option(s) _only_ function in a browser context: +Browser Mocha supports many, but not all [cli options](#command-line-usage). +To use a [cli option](#command-line-usage) that contains a "-", please convert the option to camel-case, (eg. `check-leaks` to `checkLeaks`). -`noHighlighting`: If set to `true`, do not attempt to use syntax highlighting on output test code. +#### Options that differ slightly from [cli options](#command-line-usage): + +`reporter` _{string|constructor}_ +You can pass a reporter's name or a custom reporter's constructor. You can find **recommended** reporters for the browser [here](#reporting). It is possible to use [built-in reporters](#reporters) as well, but we don't recommend it, (you can put your cat in the microwave, but don't blame us). + +#### Options that _only_ function in browser: + +`noHighlighting` _{boolean}_ +If set to `true`, do not attempt to use syntax highlighting on output test code. ### 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..839a523111 100644 --- a/lib/mocha.js +++ b/lib/mocha.js @@ -83,7 +83,7 @@ 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.