doc: fix incorrect test runner mock examples#63656
Open
emmayusufu wants to merge 1 commit into
Open
Conversation
The CJS mock.timers.setTime example asserted the timer ran right after setTime() with no tick() call, which contradicts the documented behavior and the ESM example above it. The mock.module example called .fn() on an export named foo. Both threw if run. Signed-off-by: Emmanuel Yusufu Kimaswa <kimaswaemma36@gmail.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two examples in the test runner mocking docs were wrong and would throw if run:
mock.timers.setTimeexample assertedcallCount() === 1right aftersetTime(1200)with notick()call. That contradicts the sentence just above it ("Timers scheduled in the past will not run when you callsetTime()") and the ESM version of the same example, which keeps the count at 0 and callstick(0)to execute the timer. Aligned the CJS version with the ESM one (and its test name).mock.moduleexample mocks an export namedfoobut then callsesmImpl.fn()/cjsImpl.fn(), so it throws on an undefinedfn. Changed the four.fnreferences to.foo.