Skip to content

test_runner: add jsdocs to MockTimers #49476

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

Merged
nodejs-github-bot merged 2 commits into from
Sep 5, 2023
Merged

test_runner: add jsdocs to MockTimers #49476

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de65b28
test_runner: add jsdocs to MockTimers
ErickWendel Sep 3, 2023
823aa0c
test_runner: apply suggestions
ErickWendel Sep 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
test_runner: apply suggestions 
Co-authored-by: Benjamin Gruenbaum <[email protected]>
Co-authored-by: Chemi Atlow <[email protected]>
  • Loading branch information
@ErickWendel @benjamingr @atlowChemi
3 people authored Sep 4, 2023
commit 823aa0cd6748dfc974c28a304f164c04cb1df4d3
6 changes: 2 additions & 4 deletions lib/internal/test_runner/mock/mock_timers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ class MockTimers {
}

/**
* Enables MockTimers for the specified timers
* Enables MockTimers for the specified timers.
* @param {string[]} timers - An array of timer types to enable, e.g., ['setTimeout', 'setInterval'].
* @throws {ERR_INVALID_STATE} If MockTimers are already enabled.
* @throws {ERR_INVALID_ARG_VALUE} If an unsupported timer type is specified.
Expand Down Expand Up @@ -527,9 +527,7 @@ class MockTimers {
}

/**
* The `[SymbolDispose]` method is a custom method that can be used to dispose of the MockTimers instance.
* It internally calls the `reset` method to reset and disable the timers.
* It is intended for internal use and should not be called directly in most cases.
* An alias for `this.reset()`, allowing the disposal of the `MockTimers` instance.
*/
[SymbolDispose]() {
this.reset();
Expand Down