Commit 816ce75
doc: missing passed, error and passed properties on TestContext
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>1 parent d825c88 commit 816ce75
1 file changed
Lines changed: 34 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3681,6 +3681,40 @@ added: | |||
| 3681 | 3681 | ||
| 3682 | 3682 | The name of the test. | |
| 3683 | 3683 | ||
| 3684 | + ### `context.passed` | ||
| 3685 | + | ||
| 3686 | + <!-- YAML | ||
| 3687 | + added: | ||
| 3688 | + - v21.7.0 | ||
| 3689 | + - v20.12.0 | ||
| 3690 | + --> | ||
| 3691 | + | ||
| 3692 | + * Type: {boolean} `false` before the test is executed, e.g. in a `beforeEach` hook. | ||
| 3693 | + | ||
| 3694 | + Indicated whether the test succeeded. | ||
| 3695 | + | ||
| 3696 | + ### `context.error` | ||
| 3697 | + | ||
| 3698 | + <!-- YAML | ||
| 3699 | + added: | ||
| 3700 | + - v21.7.0 | ||
| 3701 | + - v20.12.0 | ||
| 3702 | + --> | ||
| 3703 | + | ||
| 3704 | + * Type: {Error|null} | ||
| 3705 | + | ||
| 3706 | + The failure reason for the test/case; wrapped and available via `context.error.cause`. | ||
| 3707 | + | ||
| 3708 | + ### `context.attempt` | ||
| 3709 | + | ||
| 3710 | + <!-- YAML | ||
| 3711 | + added: v25.0.0 | ||
| 3712 | + --> | ||
| 3713 | + | ||
| 3714 | + * Type: {number} | ||
| 3715 | + | ||
| 3716 | + Number of times the test has been attempted. | ||
| 3717 | + | ||
| 3684 | 3718 | ### `context.plan(count[,options])` | |
| 3685 | 3719 | ||
| 3686 | 3720 | <!-- YAML | |
0 commit comments