Skip to content

Commit

Permalink
doc: add missing test runner option
Browse files Browse the repository at this point in the history
  • Loading branch information
MoLow committed Jul 25, 2022
1 parent da2764b commit 174198e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/
description: Add a `signal` option.
-->

* `name` {string} The name of the subtest, which is displayed when reporting
Expand All @@ -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`.
Expand Down

0 comments on commit 174198e

Please sign in to comment.