Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

docs: add "options.require" to Mocha constructor (#4630) [ci skip]

Juerg Bd35eb9debd43
diff --git a/lib/mocha.js b/lib/mocha.js
index fac1697c..f1f2e25d 100644
--- a/lib/mocha.js
+++ b/lib/mocha.js
@@ -180,10 +180,10 @@ exports.run = function(...args) {
* @param {number} [options.slow] - Slow threshold value.
* @param {number|string} [options.timeout] - Timeout threshold value.
* @param {string} [options.ui] - Interface name.
- * @param {boolean} [options.parallel] - Run jobs in parallel
- * @param {number} [options.jobs] - Max number of worker processes for parallel runs
- * @param {MochaRootHookObject} [options.rootHooks] - Hooks to bootstrap the root
- * suite with
+ * @param {boolean} [options.parallel] - Run jobs in parallel.
+ * @param {number} [options.jobs] - Max number of worker processes for parallel runs.
+ * @param {MochaRootHookObject} [options.rootHooks] - Hooks to bootstrap the root suite with.
+ * @param {string[]} [options.require] - Pathname of `rootHooks` plugin for parallel runs.
* @param {boolean} [options.isWorker] - Should be `true` if `Mocha` process is running in a worker process.
*/
function Mocha(options = {}) {