From d681e5f45664b76c6ed0f3b7aed24206abd19fea Mon Sep 17 00:00:00 2001 From: Moshe Atlow Date: Fri, 2 Jun 2023 00:01:48 +0300 Subject: [PATCH] doc: document watch option for node:test run() PR-URL: https://github.com/nodejs/node/pull/48256 Reviewed-By: Colin Ihrig Reviewed-By: Benjamin Gruenbaum Reviewed-By: Luigi Pinca --- doc/api/test.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/api/test.md b/doc/api/test.md index 118183150457d8..8c3c848fe8d936 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -744,25 +744,26 @@ changes: **Default:** `false`. * `files`: {Array} An array containing the list of files to run. **Default** matching files from [test runner execution model][]. - * `setup` {Function} A function that accepts the `TestsStream` instance - and can be used to setup listeners before any tests are run. - **Default:** `undefined`. - * `signal` {AbortSignal} Allows aborting an in-progress test execution. - * `timeout` {number} A number of milliseconds the test execution will - fail after. - If unspecified, subtests inherit this value from their parent. - **Default:** `Infinity`. * `inspectPort` {number|Function} Sets inspector port of test child process. This can be a number, or a function that takes no arguments and returns a number. If a nullish value is provided, each process gets its own port, incremented from the primary's `process.debugPort`. **Default:** `undefined`. + * `setup` {Function} A function that accepts the `TestsStream` instance + and can be used to setup listeners before any tests are run. + **Default:** `undefined`. + * `signal` {AbortSignal} Allows aborting an in-progress test execution. * `testNamePatterns` {string|RegExp|Array} A String, RegExp or a RegExp Array, that can be used to only run tests whose name matches the provided pattern. Test name patterns are interpreted as JavaScript regular expressions. For each test that is executed, any corresponding test hooks, such as `beforeEach()`, are also run. **Default:** `undefined`. + * `timeout` {number} A number of milliseconds the test execution will + fail after. + If unspecified, subtests inherit this value from their parent. + **Default:** `Infinity`. + * `watch` {boolean} Whether to run in watch mode or not. **Default:** `false`. * Returns: {TestsStream} ```mjs