1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add missing test runner option

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/43989
Refs: https://github.com/nodejs/node/pull/43554
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
This commit is contained in:
Moshe Atlow 2022-07-26 07:43:56 +03:00 committed by GitHub
parent d150ca69d8
commit 7a18ee8315
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/api/test.md
View File

@ -324,6 +324,9 @@ changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/43505
description: Add a `timeout` option.
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/43554
description: Add a `signal` option.
-->
* `name` {string} The name of the test, which is displayed when reporting test
@ -556,6 +559,9 @@ changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/43505
description: Add a `timeout` option.
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/43554
description: Add a `signal` option.
-->
* `name` {string} The name of the subtest, which is displayed when reporting
@ -569,6 +575,7 @@ changes:
* `only` {boolean} If truthy, and the test context is configured to run
`only` tests, then this test will be run. Otherwise, the test is skipped.
**Default:** `false`.
* `signal` {AbortSignal} Allows aborting an in-progress test
* `skip` {boolean|string} If truthy, the test is skipped. If a string is
provided, that string is displayed in the test results as the reason for
skipping the test. **Default:** `false`.