Skip to content

Commit

Permalink
doc: add missing test runner option
Browse files Browse the repository at this point in the history
PR-URL: #43989
Refs: #43554
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
  • Loading branch information
MoLow authored and juanarbol committed Oct 11, 2022
1 parent 8a8c7cf commit 21a29d4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/api/test.md
Expand Up @@ -321,6 +321,9 @@ internally.
<!-- YAML
added: v16.17.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/43554
description: Add a `signal` option.
- version: v16.17.0
pr-url: https://github.com/nodejs/node/pull/43505
description: Add a `timeout` option.
Expand Down Expand Up @@ -553,6 +556,9 @@ test('top level test', (t) => {
<!-- YAML
added: v16.17.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/43554
description: Add a `signal` option.
- version: v16.17.0
pr-url: https://github.com/nodejs/node/pull/43505
description: Add a `timeout` option.
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 21a29d4

Please sign in to comment.