From 32724cd5ce4e2717b38ca37a26f25e2331217fe4 Mon Sep 17 00:00:00 2001
From: Adi <61405630+ValorHeart@users.noreply.github.com>
Date: Sat, 28 Jan 2023 19:38:42 +0200
Subject: [PATCH] docs: Added types to custom reporter typescript example
 (#20191)

---
 docs/src/test-reporter-api/class-reporter.md     | 10 +++++-----
 packages/playwright-test/types/testReporter.d.ts | 10 +++++-----
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/src/test-reporter-api/class-reporter.md b/docs/src/test-reporter-api/class-reporter.md
index db05d7a7d6..b3cac403de 100644
--- a/docs/src/test-reporter-api/class-reporter.md
+++ b/docs/src/test-reporter-api/class-reporter.md
@@ -34,22 +34,22 @@ module.exports = MyReporter;
 
 ```js tab=js-ts
 // my-awesome-reporter.ts
-import { Reporter } from '@playwright/test/reporter';
+import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
 
 class MyReporter implements Reporter {
-  onBegin(config, suite) {
+  onBegin(config: FullConfig, suite: Suite) {
     console.log(`Starting the run with ${suite.allTests().length} tests`);
   }
 
-  onTestBegin(test) {
+  onTestBegin(test: TestCase) {
     console.log(`Starting test ${test.title}`);
   }
 
-  onTestEnd(test, result) {
+  onTestEnd(test: TestCase, result: TestResult) {
     console.log(`Finished test ${test.title}: ${result.status}`);
   }
 
-  onEnd(result) {
+  onEnd(result: FullResult) {
     console.log(`Finished the run: ${result.status}`);
   }
 }
diff --git a/packages/playwright-test/types/testReporter.d.ts b/packages/playwright-test/types/testReporter.d.ts
index 5697b94f3e..bc3e732fce 100644
--- a/packages/playwright-test/types/testReporter.d.ts
+++ b/packages/playwright-test/types/testReporter.d.ts
@@ -313,22 +313,22 @@ export interface FullResult {
  *
  * ```js
  * // my-awesome-reporter.ts
- * import { Reporter } from '@playwright/test/reporter';
+ * import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
  *
  * class MyReporter implements Reporter {
- *   onBegin(config, suite) {
+ *   onBegin(config: FullConfig, suite: Suite) {
  *     console.log(`Starting the run with ${suite.allTests().length} tests`);
  *   }
  *
- *   onTestBegin(test) {
+ *   onTestBegin(test: TestCase) {
  *     console.log(`Starting test ${test.title}`);
  *   }
  *
- *   onTestEnd(test, result) {
+ *   onTestEnd(test: TestCase, result: TestResult) {
  *     console.log(`Finished test ${test.title}: ${result.status}`);
  *   }
  *
- *   onEnd(result) {
+ *   onEnd(result: FullResult) {
  *     console.log(`Finished the run: ${result.status}`);
  *   }
  * }