Skip to content

doc: add missing test runner option #43989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2022
Merged

doc: add missing test runner option #43989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/api/test.md
View file
Open in desktop
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/43554
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