Skip to content

Commit

Permalink
doc: add "type" to test runner event details
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
philnash committed Aug 7, 2023
1 parent 3af7cfe commit ee84e70
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -1980,6 +1980,14 @@ clocks or actual timers outside of the mocking environment.
added:
- v18.9.0
- v16.19.0
changes:
- version:
- v20.0.0
- v18.17.0
- v19.9.0
pr-url: https://github.com/nodejs/node/pull/49014
description: added type to test:pass and test:fail events for when the test
is a suite.
-->

* Extends {ReadableStream}
Expand Down Expand Up @@ -2061,6 +2069,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.
Expand All @@ -2076,6 +2086,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.
Expand Down

0 comments on commit ee84e70

Please sign in to comment.