Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

cherry-pick(#27006): chore: document new onEnd params

Browse source
This commit is contained in:
Pavel Feldman 2023-09-11 18:17:49 -07:00
parent 7c838653d6
commit 5f78f27a7a
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/src/test-reporter-api/class-reporter.md
View file

@ -112,11 +112,11 @@ Called after all tests have been run, or testing has been interrupted. Note that
### param: Reporter.onEnd.result ### param: Reporter.onEnd.result
* since: v1.10 * since: v1.10
- `result` <[Object]> - `result` <[Object]>
- `status` <[FullStatus]<"passed"|"failed"|"timedout"|"interrupted">> - `status` <[FullStatus]<"passed"|"failed"|"timedout"|"interrupted">> Test run status.
- `startTime` <[Date]> - `startTime` <[Date]> Test run start wall time.
- `duration` <[int]> - `duration` <[int]> Test run duration in milliseconds.
Result of the full test run. Result of the full test run, `status` can be one of:
* `'passed'` - Everything went as expected. * `'passed'` - Everything went as expected.
* `'failed'` - Any test has failed. * `'failed'` - Any test has failed.
* `'timedout'` - The [`property: TestConfig.globalTimeout`] has been reached. * `'timedout'` - The [`property: TestConfig.globalTimeout`] has been reached.

2
packages/playwright/types/testReporter.d.ts vendored
View file

@ -411,7 +411,7 @@ export interface Reporter {
/** /**
* Called after all tests have been run, or testing has been interrupted. Note that this method may return a [Promise] * Called after all tests have been run, or testing has been interrupted. Note that this method may return a [Promise]
* and Playwright Test will await it. * and Playwright Test will await it.
* @param result Result of the full test run. * @param result Result of the full test run, `status` can be one of:
* - `'passed'` - Everything went as expected. * - `'passed'` - Everything went as expected.
* - `'failed'` - Any test has failed. * - `'failed'` - Any test has failed.
* - `'timedout'` - The * - `'timedout'` - The