Skip to content

doc: add missing passed and error properties on TestContext #61185

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

Open
Xstoudi wants to merge 3 commits into
base: main
Choose a base branch
from
+34 −0
Open

doc: add missing passed and error properties on TestContext #61185

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
addfc94
doc: missing `passed`, `error` and `passed` properties on `TestContext`
Xstoudi Dec 28, 2025
7c04d32
add missing props
Xstoudi Dec 28, 2025
53458bd
review
Xstoudi Dec 28, 2025
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
34 changes: 34 additions & 0 deletions doc/api/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3686,6 +3686,40 @@ added:

The name of the test.

### `context.passed`

<!-- YAML
added:
- v21.7.0
- v20.12.0
-->

* Type: {boolean} `false` before the test is executed, e.g. in a `beforeEach` hook.

Indicated whether the test succeeded.

### `context.error`

<!-- YAML
added:
- v21.7.0
- v20.12.0
-->

* Type: {Error|null}

The failure reason for the test/case; wrapped and available via `context.error.cause`.

### `context.attempt`

<!-- YAML
added: v25.0.0
-->

* Type: {number}

Number of times the test has been attempted.

### `context.plan(count[,options])`

<!-- YAML
Expand Down
Loading