Skip to content

armgit / mocha

Public Imported from GitHub
0

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

add --no-timeouts to docs; closes #3137 (#3176)

Dina Berryb2697a7f5fca
diff --git a/docs/index.md b/docs/index.md
index c45133ca..9ca10ee2 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -817,7 +817,7 @@ Only interested in the first exception? use `--bail`!
### `-d, --debug`
-Enables node's debugger support, this executes your script(s) with `node debug <file ...>` allowing you to step through code and break with the `debugger` statement. Note the difference between `mocha debug` and `mocha --debug`: `mocha debug` will fire up node's built-in debug client, `mocha --debug` will allow you to use a different interface — such as the Blink Developer Tools.
+Enables node's debugger support, this executes your script(s) with `node debug <file ...>` allowing you to step through code and break with the `debugger` statement. Note the difference between `mocha debug` and `mocha --debug`: `mocha debug` will fire up node's built-in debug client, `mocha --debug` will allow you to use a different interface — such as the Blink Developer Tools. Implies `--no-timeouts`.
### `--globals <names>`
@@ -845,6 +845,10 @@ The `--reporter` option allows you to specify the reporter that will be used, de
Specifies the test-case timeout, defaulting to 2 seconds. To override you may pass the timeout in milliseconds, or a value with the `s` suffix, ex: `--timeout 2s` or `--timeout 2000` would be equivalent.
+### `--no-timeouts`
+
+Disables timeouts. Equivalent to `--timeout 0`.
+
### `-s, --slow <ms>`
Specify the "slow" test threshold, defaulting to 75ms. Mocha uses this to highlight test-cases that are taking too long.