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

microsoft · Sep 12, 2023 · 5f78f27 · 5f78f27
1 parent 7c83865
commit 5f78f27
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/src/test-reporter-api/class-reporter.md b/docs/src/test-reporter-api/class-reporter.md
@@ -112,11 +112,11 @@ Called after all tests have been run, or testing has been interrupted. Note that
 ### param: Reporter.onEnd.result
 * since: v1.10
 - `result` <[Object]>
-  - `status` <[FullStatus]<"passed"|"failed"|"timedout"|"interrupted">>
-  - `startTime` <[Date]>
-  - `duration` <[int]>
+  - `status` <[FullStatus]<"passed"|"failed"|"timedout"|"interrupted">> Test run status.
+  - `startTime` <[Date]> Test run start wall time.
+  - `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.
 * `'failed'` - Any test has failed.
 * `'timedout'` - The [`property: TestConfig.globalTimeout`] has been reached.

diff --git a/packages/playwright/types/testReporter.d.ts b/packages/playwright/types/testReporter.d.ts
@@ -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]
    * 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.
    * - `'failed'` - Any test has failed.
    * - `'timedout'` - The