Commit 72f42b9
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 5635f23 commit 72f42b9
1 file changed
Lines changed: 34 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3686,6 +3686,40 @@ added: | |||
| 3686 | 3686 | ||
| 3687 | 3687 | The name of the test. | |
| 3688 | 3688 | ||
| 3689 | + ### `context.passed` | ||
| 3690 | + | ||
| 3691 | + <!-- YAML | ||
| 3692 | + added: | ||
| 3693 | + - v21.7.0 | ||
| 3694 | + - v20.12.0 | ||
| 3695 | + --> | ||
| 3696 | + | ||
| 3697 | + * Type: {boolean} `false` before the test is executed, e.g. in a `beforeEach` hook. | ||
| 3698 | + | ||
| 3699 | + Indicated whether the test succeeded. | ||
| 3700 | + | ||
| 3701 | + ### `context.error` | ||
| 3702 | + | ||
| 3703 | + <!-- YAML | ||
| 3704 | + added: | ||
| 3705 | + - v21.7.0 | ||
| 3706 | + - v20.12.0 | ||
| 3707 | + --> | ||
| 3708 | + | ||
| 3709 | + * Type: {Error|null} | ||
| 3710 | + | ||
| 3711 | + The failure reason for the test/case; wrapped and available via `context.error.cause`. | ||
| 3712 | + | ||
| 3713 | + ### `context.attempt` | ||
| 3714 | + | ||
| 3715 | + <!-- YAML | ||
| 3716 | + added: v25.0.0 | ||
| 3717 | + --> | ||
| 3718 | + | ||
| 3719 | + * Type: {number} | ||
| 3720 | + | ||
| 3721 | + Number of times the test has been attempted. | ||
| 3722 | + | ||
| 3689 | 3723 | ### `context.plan(count[,options])` | |
| 3690 | 3724 | ||
| 3691 | 3725 | <!-- YAML | |
0 commit comments