docs(ES6ClassMocks): add clarity for module factory limitations #12453
Conversation
This file contains 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
john-u
force-pushed
the
docs-module-factory
branch
from
a4f125b
to
7a51d09
Compare
- close jestjs#11862 - related to jestjs#11455
john-u
force-pushed
the
docs-module-factory
branch
from
7a51d09
to
133b50d
Compare
|
Should I also update |
no this is good, thanks |
SimenB
reviewed
Feb 22, 2022
docs/Es6ClassMocks.md
Outdated
| @@ -140,7 +140,11 @@ jest.mock('./sound-player', () => { | |||
| }); | |||
| ``` | |||
|
|
|||
| A limitation with the factory parameter is that, since calls to `jest.mock()` are hoisted to the top of the file, it's not possible to first define a variable and then use it in the factory. An exception is made for variables that start with the word 'mock'. It's up to you to guarantee that they will be initialized on time! For example, the following will throw an out-of-scope error due to the use of 'fake' instead of 'mock' in the variable declaration: | |||
| :::caution | |||
| Since calls to `jest.mock()` are hoisted to the top of the file, Jest prevents access to out-of-scope variables. By default, you cannot first define a variable and then use it in the factory. Jest will disable this check for variables that start with the word 'mock'. However, it is still up to you to guarantee that they will be initialized on time. Be aware of [Temporal Dead Zone](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/let#temporal_dead_zone_tdz). | |||
There was a problem hiding this comment.
temporal dead zone, I didn't know this had a name! 😀 Awesome stuff
SimenB
reviewed
Feb 22, 2022
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
ReferenceError: Cannot access 'myMock' before initializationif test itself and 'myMock' are in different files #11455Summary
Modify verbiage and include another code example to make it clear that there is a language-level limitation outside of Jest when using the module factory pattern.