Skip to content

Commit

Permalink
doc: refine when file is undefined in test events
Browse files Browse the repository at this point in the history
PR-URL: #48451
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
  • Loading branch information
MoLow authored and ruyadorno committed Sep 12, 2023
1 parent feb6a54 commit 820aa55
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -1398,7 +1398,7 @@ Emitted when code coverage is enabled and all tests have completed.

* `data` {Object}
* `file` {string|undefined} The path of the test file,
undefined if test is not ran through a file.
`undefined` if test was run through the REPL.
* `name` {string} The test name.
* `nesting` {number} The nesting level of the test.

Expand All @@ -1408,7 +1408,7 @@ Emitted when a test is dequeued, right before it is executed.

* `data` {Object}
* `file` {string|undefined} The path of the test file,
undefined if test is not ran through a file.
`undefined` if test was run through the REPL.
* `message` {string} The diagnostic message.
* `nesting` {number} The nesting level of the test.

Expand All @@ -1418,7 +1418,7 @@ Emitted when [`context.diagnostic`][] is called.

* `data` {Object}
* `file` {string|undefined} The path of the test file,
undefined if test is not ran through a file.
`undefined` if test was run through the REPL.
* `name` {string} The test name.
* `nesting` {number} The nesting level of the test.

Expand All @@ -1431,7 +1431,7 @@ Emitted when a test is enqueued for execution.
* `duration` {number} The duration of the test in milliseconds.
* `error` {Error} The error thrown by the test.
* `file` {string|undefined} The path of the test file,
undefined if test is not ran through a file.
`undefined` if test was run through the REPL.
* `name` {string} The test name.
* `nesting` {number} The nesting level of the test.
* `testNumber` {number} The ordinal number of the test.
Expand All @@ -1446,7 +1446,7 @@ Emitted when a test fails.
* `details` {Object} Additional execution metadata.
* `duration` {number} The duration of the test in milliseconds.
* `file` {string|undefined} The path of the test file,
undefined if test is not ran through a file.
`undefined` if test was run through the REPL.
* `name` {string} The test name.
* `nesting` {number} The nesting level of the test.
* `testNumber` {number} The ordinal number of the test.
Expand All @@ -1459,7 +1459,7 @@ Emitted when a test passes.

* `data` {Object}
* `file` {string|undefined} The path of the test file,
undefined if test is not ran through a file.
`undefined` if test was run through the REPL.
* `nesting` {number} The nesting level of the test.
* `count` {number} The number of subtests that have ran.

Expand All @@ -1469,7 +1469,7 @@ Emitted when all subtests have completed for a given test.

* `data` {Object}
* `file` {string|undefined} The path of the test file,
undefined if test is not ran through a file.
`undefined` if test was run through the REPL.
* `name` {string} The test name.
* `nesting` {number} The nesting level of the test.

Expand Down

0 comments on commit 820aa55

Please sign in to comment.