From 195885c8f8e5fa5621642c2e582e9b0212621f0e Mon Sep 17 00:00:00 2001
From: Phil Nash <philnash@gmail.com>
Date: Tue, 8 Aug 2023 20:43:42 +0200
Subject: [PATCH] doc: add "type" to test runner event details

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) the test runner
started reporting on whether a test was a suite. This was exposed to
reporters in the `details` object of a `test:pass` or `test:fail` event
but this hasn't been documented. This adds the `type` property to both
event's `details` object.

PR-URL: https://github.com/nodejs/node/pull/49014
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
---
 doc/api/test.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/api/test.md b/doc/api/test.md
index 9a5c100959c8ea..375cd41c949e8b 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1995,6 +1995,13 @@ clocks or actual timers outside of the mocking environment.
 added:
   - v18.9.0
   - v16.19.0
+changes:
+  - version:
+    - v20.0.0
+    - v19.9.0
+    - v18.17.0
+    pr-url: https://github.com/nodejs/node/pull/47094
+    description: added type to test:pass and test:fail events for when the test is a suite.
 -->
 
 * Extends {ReadableStream}
@@ -2076,6 +2083,8 @@ Emitted when a test is enqueued for execution.
     * `duration_ms` {number} The duration of the test in milliseconds.
     * `error` {Error} An error wrapping the error thrown by the test.
       * `cause` {Error} The actual error thrown by the test.
+    * `type` {string|undefined} The type of the test, used to denote whether
+      this is a suite.
   * `file` {string|undefined} The path of the test file,
     `undefined` if test was run through the REPL.
   * `name` {string} The test name.
@@ -2091,6 +2100,8 @@ Emitted when a test fails.
 * `data` {Object}
   * `details` {Object} Additional execution metadata.
     * `duration_ms` {number} The duration of the test in milliseconds.
+    * `type` {string|undefined} The type of the test, used to denote whether
+      this is a suite.
   * `file` {string|undefined} The path of the test file,
     `undefined` if test was run through the REPL.
   * `name` {string} The test name.