GeezerVison is showing github.com — doc: add "type" to test runner event details · nodejs/node@e374ba2
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/api/test.md +11-1Lines changed: 11 additions & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -1920,7 +1920,13 @@ clocks or actual timers outside of the mocking environment. |
1920 | 1920 | ## Class: `TestsStream` |
1921 | 1921 |
|
1922 | 1922 | <!-- YAML |
1923 | | -added: v18.9.0 |
| 1923 | +added: |
| 1924 | + - v18.9.0 |
| 1925 | + - v16.19.0 |
| 1926 | +changes: |
| 1927 | + - version: v18.17.0 |
| 1928 | + pr-url: https://github.com/nodejs/node/pull/47094 |
| 1929 | + description: added type to test:pass and test:fail events for when the test is a suite. |
1924 | 1930 | --> |
1925 | 1931 |
|
1926 | 1932 | * Extends {ReadableStream} |
@@ -2002,6 +2008,8 @@ Emitted when a test is enqueued for execution. |
2002 | 2008 | * `duration_ms` {number} The duration of the test in milliseconds. |
2003 | 2009 | * `error` {Error} An error wrapping the error thrown by the test. |
2004 | 2010 | * `cause` {Error} The actual error thrown by the test. |
| 2011 | + * `type` {string|undefined} The type of the test, used to denote whether |
| 2012 | + this is a suite. |
2005 | 2013 | * `file` {string|undefined} The path of the test file, |
2006 | 2014 | `undefined` if test was run through the REPL. |
2007 | 2015 | * `name` {string} The test name. |
@@ -2017,6 +2025,8 @@ Emitted when a test fails. |
2017 | 2025 | * `data` {Object} |
2018 | 2026 | * `details` {Object} Additional execution metadata. |
2019 | 2027 | * `duration_ms` {number} The duration of the test in milliseconds. |
| 2028 | + * `type` {string|undefined} The type of the test, used to denote whether |
| 2029 | + this is a suite. |
2020 | 2030 | * `file` {string|undefined} The path of the test file, |
2021 | 2031 | `undefined` if test was run through the REPL. |
2022 | 2032 | * `name` {string} The test name. |
|