Skip to content

doc(test): add missing passed and error on TextContext #59322

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

Closed
SimonSchick wants to merge 5 commits into from
Closed

doc(test): add missing passed and error on TextContext #59322

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52e1c98
doc: add missing `passed` and `error` properties on `TextContext` docs
SimonSchick Aug 1, 2025
7ddb4dc
fixup! docs(test): add missing docs for passed and error properties o…
SimonSchick Aug 1, 2025
410f075
fixup! fixup! docs(test): add missing docs for passed and error prope…
SimonSchick Aug 1, 2025
eb93b06
fixup! fixup! fixup! docs(test): add missing docs for passed and erro…
SimonSchick Aug 4, 2025
82ec081
Update doc/api/test.md
SimonSchick Aug 10, 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
Prev Previous commit
Next Next commit
fixup! fixup! fixup! docs(test): add missing docs for passed and erro… 
…r properties on TextContext
  • Loading branch information
@SimonSchick
SimonSchick committed Aug 4, 2025
commit eb93b06e94bbd329faa86b53e1716fde93baf8d1
5 changes: 2 additions & 3 deletions doc/api/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3613,16 +3613,15 @@ The name of the test.
added: v20.12.0

@aduh95 aduh95 Aug 27, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the PR you linked

Suggested change
added: v20.12.0
added:
- v21.7.0
- v20.12.0

@BridgeAR BridgeAR Sep 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aduh95 should we land it as is and have a follow-up PR? This seems to already improve the situation over what we have right now.

-->

Indicates whether the test succeeded, this defaults to `true` before the test is executed, e.g. in a `beforeEach` hook.
Indicates whether the test succeeded, this defaults to `false` before the test is executed, e.g. in a `beforeEach` hook.

### `context.error` {Error|null}

<!-- YAML
added: v20.12.0

@aduh95 aduh95 Aug 27, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here I reckon

Suggested change
added: v20.12.0
added:
- v21.7.0
- v20.12.0

-->

The failure reason for this test, if a non `Error` object was thrown it will be wrapped and available via the `cause`
property.
The failure reason for the test/case; if anything other than an instance of `Error` was thrown, that will be wrapped and available via `context.error.cause`.
Comment thread
SimonSchick marked this conversation as resolved.
Outdated

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

Expand Down
Loading