Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: refine when file is undefined in test events #48451

Merged
merged 1 commit into from Jun 14, 2023
Merged

doc: refine when file is undefined in test events #48451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/api/test.md
View file
Open in desktop
Expand Up @@ -1465,7 +1465,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 @@ -1475,7 +1475,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 @@ -1485,7 +1485,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 @@ -1498,7 +1498,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 @@ -1513,7 +1513,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 @@ -1526,7 +1526,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 @@ -1536,7 +1536,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